[pve-docs.git] / debian / tree / pve-docs-mediawiki / 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' );
# ---->8----
Commit	Line	Data
	1	To enable the apache site use:
	2
	3	# a2ensite pve-docs.conf
	4	# /etc/init.d/apache2 reload
	5
	6	Now you should be able to access the documentation at:
	7
	8	* Admin Guide and Manual pages
	9	http://your-server/pve-docs
	10
	11	* API Viewer
	12	http://your-server/pve-docs/api-viewer
	13
	14	Mediawiki import
	15
	16	There is a small script 'pve-docs-mediawiki-import' which connects to
	17	mediawiki and updates predefined pages with content from this package:
	18
	19	# pve-docs-mediawiki-import
	20
	21	Authentification credientials are read from '/root/.pve-docs'.
	22	The format is 'username:password'.
	23
	24	In the MediaWiki settings PHP file ('/var/www/mediawiki/LocalSettings.php') add:
	25
	26	# ----8<----
	27	# for docs-inclusion plugin:
	28	wfLoadExtension( 'PVEDocs' );
	29	# ---->8----