Mercurial > prosody-wiki

annotate mod_admin_web.wiki @ 192:9c5790cbea36

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
(Finally) added some documentation for mod_admin_web.
author florob@babelmonkeys.de
date Fri, 06 May 2011 18:27:37 +0000
parents
children 140beda24a8c
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
9c5790cbea36 (Finally) added some documentation for mod_admin_web.
florob@babelmonkeys.de
parents:
diff changeset
5 This module provides a very basic web administration interface.
9c5790cbea36 (Finally) added some documentation for mod_admin_web.
florob@babelmonkeys.de
parents:
diff changeset
6 It currently gives you access to Ad-Hoc commands on any virtual host you are administrator for. It also provides a live list of all S2S and C2S connections.
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
9c5790cbea36 (Finally) added some documentation for mod_admin_web.
florob@babelmonkeys.de
parents:
diff changeset
9 = Installation =
9c5790cbea36 (Finally) added some documentation for mod_admin_web.
florob@babelmonkeys.de
parents:
diff changeset
10
9c5790cbea36 (Finally) added some documentation for mod_admin_web.
florob@babelmonkeys.de
parents:
diff changeset
11 Copy the admin_web directory into prosody's plugin directory and execute the contained get_deps.sh script. This will require wget, tar, make and a basic shell.
9c5790cbea36 (Finally) added some documentation for mod_admin_web.
florob@babelmonkeys.de
parents:
diff changeset
12
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
9c5790cbea36 (Finally) added some documentation for mod_admin_web.
florob@babelmonkeys.de
parents:
diff changeset
15 "admin_web" needs to be added to the modules_enabled table of the host you want to load this module on. The port can optionally be specified with the webadmin_http_ports option.
9c5790cbea36 (Finally) added some documentation for mod_admin_web.
florob@babelmonkeys.de
parents:
diff changeset
16 By default the interface will then be reachable under `http://example.com:5280/admin`.
9c5790cbea36 (Finally) added some documentation for mod_admin_web.
florob@babelmonkeys.de
parents:
diff changeset
17 {{{
9c5790cbea36 (Finally) added some documentation for mod_admin_web.
florob@babelmonkeys.de
parents:
diff changeset
18 Host "example.com"
9c5790cbea36 (Finally) added some documentation for mod_admin_web.
florob@babelmonkeys.de
parents:
diff changeset
19 modules_enabled = {
9c5790cbea36 (Finally) added some documentation for mod_admin_web.
florob@babelmonkeys.de
parents:
diff changeset
20 .....
9c5790cbea36 (Finally) added some documentation for mod_admin_web.
florob@babelmonkeys.de
parents:
diff changeset
21 "admin_web";
9c5790cbea36 (Finally) added some documentation for mod_admin_web.
florob@babelmonkeys.de
parents:
diff changeset
22 .....
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 webadmin_http_ports = { 8080 };
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 = Compatibility =
9c5790cbea36 (Finally) added some documentation for mod_admin_web.
florob@babelmonkeys.de
parents:
diff changeset
29 ||0.8||Works||
9c5790cbea36 (Finally) added some documentation for mod_admin_web.
florob@babelmonkeys.de
parents:
diff changeset
30 ||To be 0.9||Works||