pve-docs/debian/tree/pve-docs-mediawiki
Thomas Lamprecht d95c639783 mediawiki: add a bit to README
Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>
2019-07-25 17:30:26 +02:00
..
pve-docs.conf add new pve-docs-mediawiki package 2016-08-09 07:55:35 +02:00
pvedocs-include.php mediawiki: make docs include plugin tags robuster for new MW version 2019-07-25 17:22:38 +02:00
README mediawiki: add a bit to README 2019-07-25 17:30:26 +02:00

To enable the apache site use:

# a2ensite pve-docs.conf
# /etc/init.d/apache2 reload

Now you should be able to access the documentation at:

* Admin Guide and Manual pages
http://your-server/pve-docs

* API Viewer
http://your-server/pve-docs/api-viewer

Mediawiki import

There is a small script 'pve-docs-mediawiki-import' which connects to
mediawiki and updates predefined pages with content from this package:

 # pve-docs-mediawiki-import

Authentification credientials are read from '/root/.pve-docs'.
The format is 'username:password'.

In the MediaWiki settings PHP file ('/var/www/mediawiki/LocalSettings.php') add:

# ----8<----
# for docs-inclusion plugin:
require_once("/usr/lib/pve-docs/pvedocs-include.php");

# for the JS snippet which generates the Table of Content and footer links
$wgHooks['BeforePageDisplay'][] = function( OutputPage &$out, Skin &$skin ) {
    $asciidoc_js = file_get_contents("/usr/share/doc/pve-docs-mediawiki/mediawiki-asciidoc.js");
    $out->addInlineScript($asciidoc_js);
};
# ---->8----