Mercurial > prosody-modules

comparison mod_admin_web/README.markdown @ 1803:4d73a1a6ba68

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Convert all wiki pages to Markdown
author Kim Alvefur <zash@zash.se>
date Fri, 28 Aug 2015 18:03:58 +0200
parents mod_admin_web/README.wiki@29f3d6b7ad16
children bcff0e8b7b4d
comparison
equal deleted inserted replaced
1802:0ab737feada6 1803:4d73a1a6ba68
1 ---
2 labels:
3 - 'Stage-Beta'
4 summary: Web administration interface
5 ...
6
7 Introduction
8 ============
9
10 This module provides a basic web administration interface. It currently
11 gives you access to Ad-Hoc commands on any virtual host or component
12 that you are set as an administrator for in the Prosody config file. It
13 also provides a live list of all S2S and C2S connections.
14
15 Installation
16 ============
17
18 1. Copy the admin\_web directory into a directory Prosody will check
19 for plugins. (cf. [Installing
20 modules](http://prosody.im/doc/installing_modules))
21 2. Execute the contained get\_deps.sh script from within the admin\_web
22 directory. (Requires wget, tar, and a basic shell)
23
24 Configuration Details
25 =====================
26
27 "admin\_web" needs to be added to the modules\_enabled table of the host
28 you want to load this module on.
29
30 By default the interface will then be reachable under
31 `http://example.com:5280/admin`, or `https://example.com:5281/admin`.
32
33 The module will automatically enable two other modules if they aren't
34 already: mod\_bosh (used to connect to the server from the web), and
35 mod\_admin\_adhoc (which provides admin commands over XMPP).
36
37 VirtualHost "example.com"
38 modules_enabled = {
39 .....
40 "admin_web";
41 .....
42 }
43
44 Compatibility
45 =============
46
47 --------- ---------------
48 trunk Works
49 0.9 Works
50 \<= 0.8 Not supported
51 --------- ---------------