Browsing Whonix ™ Documentation Offline

From Whonix



Install git.

1. Update the package lists.

sudo apt-get update

2. Upgrade the system.

sudo apt-get dist-upgrade

3. Install the git package.

Using apt-get command line parameter --no-install-recommends is in most cases optional.

sudo apt-get install --no-install-recommends git

The procedure of installing git is complete.

Use git to download the Whonix ™ wiki documentation.

git clone --depth=1


x-www-browser ~/whonix-wiki-html/Documentation.html


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


Whonix first time users warning 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.

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


  • Some links might be broken.
  • Large image view is broken. [archive]
  • 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] [archive]

Wiki Database Dump[edit]

A) Whonix ™ wiki as mediawiki XML database dump not including full history dumpContent.xml but including all wiki images [archive]

  • Using git, on gitlab.
  • Ugly binary file.
  • Restoration possible in new mediawiki.
  • rsync://

B) Whonix ™ wiki as mediawiki XML database dump including full history but not including wiki images dumpContent.xml [archive]

  • dumpContent.xml.sha512sum [archive]
  • Not using git because file size to big.
  • Ugly binary file.
  • Restoration possible in new mediawiki.
  • rsync://


  • Best to combine the two downloads above (full history A + all wiki images B).
  • Possible to rsync from

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/whonix-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]

Fosshost is sponsors Kicksecure ™ stage server Whonix old logo.png
Fosshost About Advertisements

Search engines: YaCy | Qwant | ecosia | MetaGer | peekier | Whonix ™ Wiki

Follow: 1024px-Telegram 2019 Logo.svg.png Iconfinder Apple Mail 2697658.png Twitter.png Facebook.png Rss.png Reddit.jpg 200px-Mastodon Logotype (Simple).svg.png

Support: Discourse logo.png

Donate: Donate Bank Wire Paypal Bitcoin accepted here Monero accepted here Contriute

Whonix donate bitcoin.png Monero donate Whonix.png United Federation of Planets 1000px.png

Twitter-share-button.png Facebook-share-button.png Telegram-share.png link=mailto:?subject=Offline Documentation&body= link= Documentation link= Documentation link= Documentation%20 Documentation

Want to help create awesome, up-to-date screenshots for the Whonix ™ wiki? Help is most welcome!

https link onion link Priority Support | Investors | Professional Support

Whonix | © ENCRYPTED SUPPORT LP | Heckert gnu.big.png Freedom Software / Osi standard logo 0.png Open Source (Why?)

The personal opinions of moderators or contributors to the Whonix ™ project do not represent the project as a whole.

By using our website, you acknowledge that you have read, understood and agreed to our Privacy Policy, Cookie Policy, Terms of Service, and E-Sign Consent.