pve-docs

mirror of https://git.proxmox.com/git/pve-docs synced 2025-12-05 05:17:05 +00:00

History

Thomas Lamprecht 3e5c017486 mediawiki: make docs include plugin tags robuster for new MW version Some (new) mediawiki versions can convert '<' and '>' to '<' or '>', this resulted in a situation where our encoded tag did not get detected by the decode logic, and thus a visitor only saw something like the following: > <--- @PVEDOCHACK@ > PCEtLSBhc2NpaWRvYyBIRUFERVIgLS0+DQo8c2NyaXB0IHR5..... > @PVEDOCHACK@ --> The word "HACK" was a bit unfortunate too, as it could be interpreted as in the docs got hacked, by unknowing people. So change that too to 'PVEDOCS_BASE64' Signed-off-by: Thomas Lamprecht <t.lamprecht@proxmox.com>		2019-07-25 17:22:38 +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	update for our new mediawiki installation	2016-08-11 12:55:38 +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'.

require_once("/usr/lib/pve-docs/pvedocs-include.php");