Browsing Whonix ™ Documentation Offline

From Whonix

Offline-2342342354.png

Installation[edit]

Install package(s) git.

A. Update the package lists and upgrade the system.

sudo apt update && sudo apt full-upgrade

B. Install the git package(s).

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

sudo apt install --no-install-recommends git

C. Done.

The procedure of installing package(s) git is complete.

mkdir ~/Downloads/

cd ~/Downloads/

Use git to download the Whonix ™ wiki documentation.

git clone --depth=1 https://gitlab.com/whonix/whonix-wiki-html.git

Usage[edit]

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

Advantages[edit]

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

Warnings[edit]

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.

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

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) Whonix ™ 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://whonix.org/whonix/developer-meta-files/whonix-wiki-backup-dump-content-current

B) Whonix ™ 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://whonix.org/whonix/developer-meta-files/whonix-wiki-backup-dump-content-full

Hints:

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

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]

Retrieved from "https://www.whonix.org/w/index.php?title=Offline_Documentation&oldid=86843"