Mercurial > prosody-wiki

annotate mod_admin_web.wiki @ 396:5720e3f68061

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Update docs for lpty-based version
author MWild1@gmail.com
date Tue, 13 Aug 2013 17:47:14 +0000
parents 53771c083c19
children
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
338
d3f2060ac16a Re-add Installation section.
florob@babelmonkeys.de
parents: 337
diff changeset
8 = Installation =
d3f2060ac16a Re-add Installation section.
florob@babelmonkeys.de
parents: 337
diff changeset
9
d3f2060ac16a Re-add Installation section.
florob@babelmonkeys.de
parents: 337
diff changeset
10 # Copy the admin_web directory into a directory Prosody will check for plugins. (cf. [http://prosody.im/doc/installing_modules Installing modules])
d3f2060ac16a Re-add Installation section.
florob@babelmonkeys.de
parents: 337
diff changeset
11 # Execute the contained get_deps.sh script from within the admin_web directory. (Requires wget, tar, and a basic shell)
d3f2060ac16a Re-add Installation section.
florob@babelmonkeys.de
parents: 337
diff changeset
12
192
9c5790cbea36 (Finally) added some documentation for mod_admin_web.
florob@babelmonkeys.de
parents:
diff changeset
13 = Configuration Details =
9c5790cbea36 (Finally) added some documentation for mod_admin_web.
florob@babelmonkeys.de
parents:
diff changeset
14
297
f50173b0d169 Update config for timber
MWild1@gmail.com
parents: 273
diff changeset
15 "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
16
337
da79793316ff Since this only works starting with 0.9 remove autoloaded modules from modules_enabled.
florob@babelmonkeys.de
parents: 297
diff changeset
17 By default the interface will then be reachable under `http://example.com:5280/admin`, or `https://example.com:5281/admin`.
297
f50173b0d169 Update config for timber
MWild1@gmail.com
parents: 273
diff changeset
18
f50173b0d169 Update config for timber
MWild1@gmail.com
parents: 273
diff changeset
19 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
20
192
9c5790cbea36 (Finally) added some documentation for mod_admin_web.
florob@babelmonkeys.de
parents:
diff changeset
21 {{{
297
f50173b0d169 Update config for timber
MWild1@gmail.com
parents: 273
diff changeset
22 VirtualHost "example.com"
192
9c5790cbea36 (Finally) added some documentation for mod_admin_web.
florob@babelmonkeys.de
parents:
diff changeset
23 modules_enabled = {
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 "admin_web";
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 }
9c5790cbea36 (Finally) added some documentation for mod_admin_web.
florob@babelmonkeys.de
parents:
diff changeset
28 }}}
9c5790cbea36 (Finally) added some documentation for mod_admin_web.
florob@babelmonkeys.de
parents:
diff changeset
29
9c5790cbea36 (Finally) added some documentation for mod_admin_web.
florob@babelmonkeys.de
parents:
diff changeset
30 = Compatibility =
297
f50173b0d169 Update config for timber
MWild1@gmail.com
parents: 273
diff changeset
31 ||trunk||Works||
339
53771c083c19 Be explicit about not supporting mod_admin_web with Prosody 0.8
florob@babelmonkeys.de
parents: 338
diff changeset
32 ||0.9||Works||
53771c083c19 Be explicit about not supporting mod_admin_web with Prosody 0.8
florob@babelmonkeys.de
parents: 338
diff changeset
33 ||<= 0.8||Not supported||