Browsing Kicksecure Documentation Offline

™

Download

Debian morph to Kicksecure (Hardware) Windows (VM) Linux (VM) Mac (VM) VirtualBox (VM) KVM (VM) Qubes (VM) USB ISO (coming soon) More options Source Code

About

Overview Features Why Open Source? Project Activities Contributors Mission & Vision

Docs

Documentation FAQ Troubleshooting

Community

Forums Contribute

Support

Free Plus Premium Contact

Tools Upload file Special pages Recent changes Print Version Page meta What links here Related changes Page information

Page Read Edit History Move Protection Unwatch Watch Delete Purge

User Preferences Watchlist Contributions Logout Create account Login

Donate

Installation

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

x-www-browser ~/Downloads/kicksecure-wiki-html/Documentation.html

Advantages

• Very fast to browse once installed.
• Higher privacy.

Warnings

Warning: For users who intend to avoid internet connections.

No special measures were taken to enforce not using the internet. When clicking external links, the internet will be used. Browsing offline documentation pages might result in external internet connections. If external content must not be loaded, disable networking of the virtual machine or the host computer.

Offline documentation will likely be older than online documentation. For time critical issues such as version numbers refer to the online version.

Limitations

• 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

https://forums.whonix.org/t/offline-documentation-discussion/413/89

Wiki Database Dump

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

• 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

• https://github.com/Kicksecure/kicksecure-discourse-html-backup

---

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.

Kicksecure A secure by default operating system with the latest security research in place.

Dark mode

Follow us on social media

FREE  ·  PLUS  ·  PREMIUM Support

At Kicksecure we value freedom and trust, supporting Open Source and Freedom Software

By using this website, you acknowledge you have read, understood, and agree to be bound by these these agreements: Terms of Service, Privacy Policy, Cookie Policy, E-Sign Consent, DMCA, Imprint Kicksecure ENCRYPTED SUPPORT LP, 2023

Your support makes
all the difference!

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!