Mercurial > prosody-modules

comparison mod_admin_web/README.md @ 5975:fe081789f7b5

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
All community modules: Unify file extention of Markdown files to .md
author Menel <menel@snikket.de>
date Tue, 22 Oct 2024 10:26:01 +0200
parents mod_admin_web/README.markdown@f649305d0bec
children 73915ac32649
comparison
equal deleted inserted replaced
5974:5a65a632d5b9 5975:fe081789f7b5
1 ---
2 labels:
3 - 'Stage-Beta'
4 summary: Web administration interface
5 rockspec:
6 build:
7 platforms:
8 unix:
9 type: command
10 build_command: cd admin_web; sh get_deps.sh
11 install_command: |
12 cd admin_web;
13 cp mod_admin_web.lua $(LUADIR);
14 cp -r www_files $(PREFIX);
15 ...
16
17 Introduction
18 ============
19
20 This module provides a basic web administration interface. It currently
21 gives you access to Ad-Hoc commands on any virtual host or component
22 that you are set as an administrator for in the Prosody config file. It
23 also provides a live list of all S2S and C2S connections.
24
25 Installation
26 ============
27
28 1. Copy the admin\_web directory into a directory Prosody will check
29 for plugins. (cf. [Installing
30 modules](http://prosody.im/doc/installing_modules))
31 2. Execute the contained `get_deps.sh` script from within the admin\_web
32 directory. (Requires wget, tar, and a basic shell)
33
34 Configuration Details
35 =====================
36
37 "admin\_web" needs to be added to the modules\_enabled table of the host
38 you want to load this module on.
39
40 By default the interface will then be reachable under
41 `http://example.com:5280/admin`, or `https://example.com:5281/admin`.
42
43 The module will automatically enable two other modules if they aren't
44 already: mod\_bosh (used to connect to the server from the web), and
45 mod\_admin\_adhoc (which provides admin commands over XMPP).
46
47 VirtualHost "example.com"
48 modules_enabled = {
49 .....
50 "admin_web";
51 .....
52 }
53
54 Compatibility
55 =============
56
57 --------- ---------------
58 trunk Works
59 0.9 Works
60 \<= 0.8 Not supported
61 --------- ---------------