openinternet / documentation-builder Goto Github PK

Only saw the installation instructions for ubuntu. :)

From SAFETAG/SAFETAG#31

We have encountered a few links that have died, even in the short initial componsition time-frame. We need to create a test that grabs every link and tests to see if they are up. Ideally, it would actually check against an md5 of each page to make sure that websites that don't throw a 404 are still seen as broken links.

This would also have to scrape off the #page=## from pdf's to not cause multiple links to the same pdf to be hit multiple times.

NOTE: egrep -hro "http.*\.pdf" * | sort | uniq

Possibly using cryptsetup

wkhtmltopdf has a new release (0.12.5) - we need to test if it works in a default install and if so to update the install docs.

SAFETAG/SAFETAG#77

When trying to install QT-compiled version of wkhtmltopdf used for html-pdf conversion of current SAFETAG documentation metasploit and armatage are broken.

• Used debian wheezy 36bit download for wkhtmltopdf
• ERROR encountered:
  When using the graphical installer faced the following error.

GDBuc.Error:org.gtk.GDBus.UnmappedGError.Quark._pk_5ftransaction_5ferror.Code4:SimulateInstallFiles not supported by backend

An earlier version of wkhtmltopdf is a required package by other applications.

Using the following command allowed the latest version to be installed. But, it set metsploit, armatage and kali-linux-full to be de-installed because they don't recognize the QT version to be the same package as the one they require. As long as you don't use apt-get after this they won't get de-installed. But, we don't use them anyway with SAFETAG core so this currently works.

apt-get remove wkhtmltopdf
dpkg --install  [WKHTMLTOPDF.deb]
apt-get install -f

(this is an upstream problem, but as noted, "This should stay open. We need to actually find an upstream fix to this. SAFETAG breaking metasploit is just silly."

The current make based installer is a dependency hell. As such, a debian package is the best path forward.

There are concerns.

• What is the best installation path for a package that we desire the user to edit.
• Do we add basic git pull ability into the package so that the user can keep their SAFETAG content up to date before they build?
• Should this be a seperate repository that pulls from the git content and places it in a specific directory?
• How do we best incorporate GUI control into a seperate package like this?

Moved in from SAFETAG/SAFETAG#82

It should be possible to build a specific SAFETAG guide section that pulls in the relevant endnotes and appendices (e.g. example/ content) for that section.

This is very possible. Currently the makefile just targets the main index's. We would want to actually script up the current builder to be more than a makefile. Once we do this it could do much much more. Here is what it would look like in make speak, but we would want to actually transition it into a language that is robust.

INDEX=path/to/index/file.md
INDEX_NAME=file_name
create_your_own: | $(SRC_DIR) $(DOC_DIR)
    modules/markdown-pp/markdown-pp.py $(INDEX) $(SRC_DIR)/$(INDEX_NAME).md
    pandoc -s --variable=title:"$(INDEX_NAME)" \
        --template=theme/html5.template \
        --to=html5 $(SRC_DIR)/$(INDEX_NAME).md \
        --output=$(SRC_DIR)/$(INDEX_NAME).html 
    wkhtmltopdf --user-style-sheet theme/core.css \
        --title "$(INDEX_NAME)" \
        --disable-smart-shrinking  \
        --load-error-handling skip \
        --load-media-error-handling skip \
        --footer-center "Page [page] of [toPage]" \
        --header-left [doctitle] \
        --outline \
        --outline-depth 2 \
        $(SRC_DIR)/$(INDEX_NAME).html $(DOC_DIR)/$(INDEX_NAME).pdf || true

Note that this is very close, but due to the SAFETAG per-chapter indices being at a different directory level than the master indices, the copy to tmp/.../target must stay at the root of the content, but the ../ structure in the index/ files can't correctly reference out.

This might end up being a SAFETAG issue again, or an extra doc builder option for the "working" directory?

This theoretically should work in OSX; but currently is not. It seems that environment variables for progdir are not being set.

Other dependency notes:

brew install pandoc should work
py-setuptools? https://gist.github.com/jj1bdx/0315955cdc8e2dde0283 https://stackoverflow.com/questions/26032836/how-to-install-setuptools-in-mac

wkhtmltox: https://github.com/wkhtmltopdf/wkhtmltopdf/releases/download/0.12.4/wkhtmltox-0.12.4_osx-cocoa-x86-64.pkg

potential reason behind the ModuleNotFoundError: No module named 'Processor' errors are python version mismatches. Current markdown-pp is tagged to an old release (at least following the current build instructions and scripts). We need to test if the newer markdown-pp version works with python 3.7.1 and the rest of the build process

From SAFETAG/SAFETAG#81

Kali-Linux and Debian wheezy currently only offer pandoc version 1.9.4.2. It seems that Ubuntu is running 1.12 with ---toc-depth support. We should add pandoc version checking to produce different outputs in the future.

See: SAFETAG/SAFETAG#79
RE: SAFETAG/SAFETAG#76

Moved in from SAFETAG/SAFETAG#172

have markdown-pp make a logfile of

• what files it touches when it runs
• what files were missing when it runs
• what files were empty when it runs

This work will actually be done in the markdown-pp repo but we are keeping a central issue queue here.