Mercurial > prosody-modules

comparison mod_admin_web2/README.md @ 6520:7eb114975cec

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_admin_web2: Fork of admin_web for prosody 13.0. It is a fork because it changes access rights and might be insecure. Mark as alpha.
author Menel <menel@snikket.de>
date Fri, 24 Apr 2026 12:40:13 +0200
parents mod_admin_web/README.md@73915ac32649
children c4d3f0c208e9
comparison
equal deleted inserted replaced
6519:01d8bfbfc435 6520:7eb114975cec
1 ---
2 labels:
3 - 'Stage-Alpha'
4 summary: Web administration interface
5 rockspec:
6 build:
7 platforms:
8 unix:
9 type: command
10 build_command: cd admin_web2; sh get_deps.sh
11 install_command: |
12 cd admin_web2;
13 cp mod_admin_web2.lua $(LUADIR);
14 cp -r www_files $(PREFIX);
15 ...
16
17 Introduction
18 ============
19
20 This module is a fork of [mod_admin_web], because that on is incompatible with prosody 13.0.
21 It was made with only small changes but also without much understanding of lua and the internal workigs of prosody. Use with care. Restrict access from the web.
22 Patches welcome.
23
24 This module provides a basic web-administration interface. It currently
25 gives you access to Ad-Hoc commands on any virtual host or component. It
26 also provides a live list of S2S and C2S connections. (buggy, not showing all of them)
27
28 **New:** You need to be the global instance operator to access this module. Smiplifying access rights.
29 **Known Issue:** If you define it on more then one host or globally, it might be nessesary to reload the module to have access to all hosts from within one interface.
30
31 Installation
32 ============
33
34 1. Copy the admin\_web directory into a directory Prosody will check
35 for plugins. (cf. [Installing
36 modules](http://prosody.im/doc/installing_modules))
37 2. **Execute the contained `get_deps.sh` script from within the admin\_web
38 directory.** (Requires wget, tar, and a basic shell)
39
40 Configuration Details
41 =====================
42
43 "admin\_web" needs to be added to the modules\_enabled table of the host
44 you want to load this module on.
45
46 By default the interface will then be reachable under
47 `http://example.com:5280/admin`, or `https://example.com:5281/admin`.
48
49 The module will automatically enable two other modules if they aren't
50 already: mod\_bosh (used to connect to the server from the web), and
51 mod\_admin\_adhoc (which provides admin commands over XMPP).
52
53 VirtualHost "example.com"
54 modules_enabled = {
55 .....
56 "admin_web";
57 .....
58 }
59
60 Compatibility
61 =============
62
63 --------- ----------------------------------
64 13.0 Works
65 0.12 not supported, use [mod_admin_web]
66 \<= 0.11 not supported
67 --------- ----------------------------------