Browsing Kicksecure Documentation Offline

Installation[edit]
Install git
. To accomplish that, the following steps A. to D. need to be done.
A. Update the package lists.
sudo apt update
B. Upgrade the system.
sudo apt full-upgrade
C. Install the git
package.
Using apt
command line parameter --no-install-recommends
is in most cases optional.
sudo apt install --no-install-recommends git
D. Done.
The procedure of installing git
is complete.
mkdir ~/Downloads/
cd ~/Downloads/
Use git
to download the Kicksecure wiki documentation.
git clone --depth=1 https://gitlab.com/kicksecure/kicksecure-wiki-html.git
Usage[edit]
x-www-browser ~/Downloads/kicksecure-wiki-html/Documentation.html
Advantages[edit]
- Very fast to browse once installed.
- Higher privacy.
Warnings[edit]
Limitations[edit]
- Some links might be broken.
- Large image view is broken.
- Simple code boxes. One has to manually select the contents of a code box for copy and paste.
- Boxes for "click on Expand on the right" are already expanded by default.
- Layout, tables look a bit different.
- Other imperfections.
Forum Discussion[edit]
https://forums.whonix.org/t/offline-documentation-discussion/413/89
Wiki Database Dump[edit]
A) Kicksecure wiki as mediawiki XML
database dump not including full history dumpContent.xml
but including all wiki images
- Using
git
, on gitlab. - Ugly binary file.
- Restoration possible in new mediawiki.
rsync://kicksecure.com/kicksecure/developer-meta-files/wiki-backup-dump-content-current
B) Kicksecure wiki as mediawiki XML
database dump including full history but not
including wiki images dumpContent.xml
dumpContent.xml.sha512sum
- Not using
git
because file size to big. - Ugly binary file.
- Restoration possible in new mediawiki.
rsync://kicksecure.com/kicksecure/developer-meta-files/wiki-backup-dump-content-full
Hints:
- Best to combine the two downloads above (full history A + all wiki images B).
- Possible to rsync from kicksecure.com.
Recommended steps to restore in a new mediawiki installation:
1) Restore full wiki history.
sudo -u www-data php /var/www/w/maintenance/importDump.php --uploads --dry-run /path/to/wiki-backup-dump-content-full/dumpContent.xml
- Path to mediawiki maintenance script
importDump.php
will likely be different. - drop:
--dry-run
- Probably also drop (likely broken)
--uploads
(not important)
2) Restore all wiki images.
sudo -u www-data php /var/www/w/maintenance/importImages.php /path/to/wiki/wiki-backup-dump-content-current/mediafiles
- Path to mediawiki maintenance script
importImages.php
will likely be different. - Check permissions. Folder to import from must be readable by user www-data. To test, run:
sudo -u www-data cp -r /path/to/wiki/wiki-backup-dump-content-current/mediafiles /tmp/delete
or so.
Alternative Wiki Backup Formats[edit]
- C) Kicksecure wiki as
mediawiki markdown
- Looks nicer.
- No automated path to restoration.
rsync://kicksecure.com/kicksecure/developer-meta-files/kicksecure-wiki-backup
- D) Kicksecure wiki as
HTML
- Looks nicer.
- No automated path to restoration.
Forum Backups[edit]
Unfinished: This wiki is a work in progress. Please do not report broken links until this notice is removed, use Search Engines First and contribute improving this wiki.

We believe security software like Kicksecure needs to remain open source and independent. Would you help sustain and grow the project? Learn more about our 10 year success story and maybe DONATE!