pve-docs

mirror of https://git.proxmox.com/git/pve-docs synced 2025-04-29 21:32:45 +00:00

History

Thomas Lamprecht 60598f4ce3 mediawiki: bring doc includer again in line with the HTMLets plug it bases on We probably always wanted to use a real HTML comment as "tag" here, but it seems the '!' was forgotten. With older mediawiki it still worked, but 1.31 got stricter and thus it was converted to HTML entities. Bring the plugin again in line with the HTMLets MediaWiki extension[0] it based on in the first place. [0]: `11e5ef1ea2/HTMLets.php (140)` Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>		2019-07-26 08:52:08 +02:00
..
pve-docs.conf	add new pve-docs-mediawiki package	2016-08-09 07:55:35 +02:00
pvedocs-include.php	mediawiki: bring doc includer again in line with the HTMLets plug it bases on	2019-07-26 08:52:08 +02:00
README	fixup: TOC JS script is already in html pages for mediawiki	2019-07-25 18:05:30 +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:
require_once("/usr/lib/pve-docs/pvedocs-include.php");
# ---->8----