pve-docs

mirror of https://git.proxmox.com/git/pve-docs synced 2025-10-26 16:01:29 +00:00

History

Thomas Lamprecht 100fc6011b mediawiki: update README for external extension path Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>		2021-05-28 16:36:14 +02:00
..
PVEDocs	mediawiki: load JS helper in plugin instead of including it in the html out	2021-05-28 16:03:59 +02:00
pve-docs.conf	add new pve-docs-mediawiki package	2016-08-09 07:55:35 +02:00
README	mediawiki: update README for external extension path	2021-05-28 16:36:14 +02:00

README

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:
wfLoadExtension( 'PVEDocs', '/usr/lib/pve-docs/PVEDocs/extension.json' );
# ---->8----