annotate mod_admin_web.wiki @ 323:d207d048c7f8

small correction.
author Marco Cirillo <maranda@lightwitch.org>
date Tue, 05 Mar 2013 17:05:04 +0000
parents f50173b0d169
children da79793316ff
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
192
9c5790cbea36 (Finally) added some documentation for mod_admin_web.
florob@babelmonkeys.de
parents:
diff changeset
1 #summary Web administration interface
9c5790cbea36 (Finally) added some documentation for mod_admin_web.
florob@babelmonkeys.de
parents:
diff changeset
2 #labels Stage-Beta
9c5790cbea36 (Finally) added some documentation for mod_admin_web.
florob@babelmonkeys.de
parents:
diff changeset
3 = Introduction =
9c5790cbea36 (Finally) added some documentation for mod_admin_web.
florob@babelmonkeys.de
parents:
diff changeset
4
297
f50173b0d169 Update config for timber
MWild1@gmail.com
parents: 273
diff changeset
5 This module provides a basic web administration interface.
f50173b0d169 Update config for timber
MWild1@gmail.com
parents: 273
diff changeset
6 It currently gives you access to Ad-Hoc commands on any virtual host or component that you are set as an administrator for in the Prosody config file. It also provides a live list of all S2S and C2S connections.
192
9c5790cbea36 (Finally) added some documentation for mod_admin_web.
florob@babelmonkeys.de
parents:
diff changeset
7
9c5790cbea36 (Finally) added some documentation for mod_admin_web.
florob@babelmonkeys.de
parents:
diff changeset
8 = Configuration Details =
9c5790cbea36 (Finally) added some documentation for mod_admin_web.
florob@babelmonkeys.de
parents:
diff changeset
9
297
f50173b0d169 Update config for timber
MWild1@gmail.com
parents: 273
diff changeset
10 "admin_web" needs to be added to the modules_enabled table of the host you want to load this module on.
f50173b0d169 Update config for timber
MWild1@gmail.com
parents: 273
diff changeset
11
f50173b0d169 Update config for timber
MWild1@gmail.com
parents: 273
diff changeset
12 By default the interface will then be reachable under `http://example.com:5280/admin`, and also `https://example.com:5281/admin`.
f50173b0d169 Update config for timber
MWild1@gmail.com
parents: 273
diff changeset
13
f50173b0d169 Update config for timber
MWild1@gmail.com
parents: 273
diff changeset
14 The module will automatically enable two other modules if they aren't already: mod_bosh (used to connect to the server from the web), and mod_admin_adhoc (which provides admin commands over XMPP).
f50173b0d169 Update config for timber
MWild1@gmail.com
parents: 273
diff changeset
15
192
9c5790cbea36 (Finally) added some documentation for mod_admin_web.
florob@babelmonkeys.de
parents:
diff changeset
16 {{{
297
f50173b0d169 Update config for timber
MWild1@gmail.com
parents: 273
diff changeset
17 VirtualHost "example.com"
192
9c5790cbea36 (Finally) added some documentation for mod_admin_web.
florob@babelmonkeys.de
parents:
diff changeset
18 modules_enabled = {
9c5790cbea36 (Finally) added some documentation for mod_admin_web.
florob@babelmonkeys.de
parents:
diff changeset
19 .....
9c5790cbea36 (Finally) added some documentation for mod_admin_web.
florob@babelmonkeys.de
parents:
diff changeset
20 "admin_web";
297
f50173b0d169 Update config for timber
MWild1@gmail.com
parents: 273
diff changeset
21 "bosh"; -- Required, auto-loaded in 0.9
f50173b0d169 Update config for timber
MWild1@gmail.com
parents: 273
diff changeset
22 "admin_adhoc"; -- Required, auto-loaded in 0.9
192
9c5790cbea36 (Finally) added some documentation for mod_admin_web.
florob@babelmonkeys.de
parents:
diff changeset
23 .....
9c5790cbea36 (Finally) added some documentation for mod_admin_web.
florob@babelmonkeys.de
parents:
diff changeset
24 }
9c5790cbea36 (Finally) added some documentation for mod_admin_web.
florob@babelmonkeys.de
parents:
diff changeset
25 }}}
9c5790cbea36 (Finally) added some documentation for mod_admin_web.
florob@babelmonkeys.de
parents:
diff changeset
26
9c5790cbea36 (Finally) added some documentation for mod_admin_web.
florob@babelmonkeys.de
parents:
diff changeset
27 = Compatibility =
297
f50173b0d169 Update config for timber
MWild1@gmail.com
parents: 273
diff changeset
28 ||trunk||Works||
f50173b0d169 Update config for timber
MWild1@gmail.com
parents: 273
diff changeset
29 ||0.9||Works||