Mercurial > prosody-modules

annotate mod_admin_web2/README.md @ 6540:7cb25e7d945d

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_muc_mav: Prevent JIDs leaking to occupants who are not allowed The occupant-id is always there so the list is still useful to them.
author Stephen Paul Weber <singpolyma@singpolyma.net>
date Mon, 18 May 2026 10:23:58 -0500
parents c4d3f0c208e9
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
1 ---
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
2 labels:
6520
7eb114975cec 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.
Menel <menel@snikket.de>
parents: 6507
diff changeset
3 - 'Stage-Alpha'
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
4 summary: Web administration interface
4179
bcff0e8b7b4d mod_admin_web: Include build instructions in metadata
Kim Alvefur <zash@zash.se>
parents: 1803
diff changeset
5 rockspec:
bcff0e8b7b4d mod_admin_web: Include build instructions in metadata
Kim Alvefur <zash@zash.se>
parents: 1803
diff changeset
6 build:
bcff0e8b7b4d mod_admin_web: Include build instructions in metadata
Kim Alvefur <zash@zash.se>
parents: 1803
diff changeset
7 platforms:
bcff0e8b7b4d mod_admin_web: Include build instructions in metadata
Kim Alvefur <zash@zash.se>
parents: 1803
diff changeset
8 unix:
bcff0e8b7b4d mod_admin_web: Include build instructions in metadata
Kim Alvefur <zash@zash.se>
parents: 1803
diff changeset
9 type: command
6520
7eb114975cec 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.
Menel <menel@snikket.de>
parents: 6507
diff changeset
10 build_command: cd admin_web2; sh get_deps.sh
4181
fcc6b92869d4 mod_admin_web: Really fix luarocks build spec
Kim Alvefur <zash@zash.se>
parents: 4179
diff changeset
11 install_command: |
6520
7eb114975cec 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.
Menel <menel@snikket.de>
parents: 6507
diff changeset
12 cd admin_web2;
7eb114975cec 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.
Menel <menel@snikket.de>
parents: 6507
diff changeset
13 cp mod_admin_web2.lua $(LUADIR);
4181
fcc6b92869d4 mod_admin_web: Really fix luarocks build spec
Kim Alvefur <zash@zash.se>
parents: 4179
diff changeset
14 cp -r www_files $(PREFIX);
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
15 ...
1782
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
16
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
17 Introduction
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
18 ============
1782
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
19
6520
7eb114975cec 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.
Menel <menel@snikket.de>
parents: 6507
diff changeset
20 This module is a fork of [mod_admin_web], because that on is incompatible with prosody 13.0.
7eb114975cec 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.
Menel <menel@snikket.de>
parents: 6507
diff changeset
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.
7eb114975cec 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.
Menel <menel@snikket.de>
parents: 6507
diff changeset
22 Patches welcome.
7eb114975cec 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.
Menel <menel@snikket.de>
parents: 6507
diff changeset
23
7eb114975cec 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.
Menel <menel@snikket.de>
parents: 6507
diff changeset
24 This module provides a basic web-administration interface. It currently
7eb114975cec 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.
Menel <menel@snikket.de>
parents: 6507
diff changeset
25 gives you access to Ad-Hoc commands on any virtual host or component. It
7eb114975cec 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.
Menel <menel@snikket.de>
parents: 6507
diff changeset
26 also provides a live list of S2S and C2S connections. (buggy, not showing all of them)
7eb114975cec 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.
Menel <menel@snikket.de>
parents: 6507
diff changeset
27
7eb114975cec 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.
Menel <menel@snikket.de>
parents: 6507
diff changeset
28 **New:** You need to be the global instance operator to access this module. Smiplifying access rights.
7eb114975cec 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.
Menel <menel@snikket.de>
parents: 6507
diff changeset
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.
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
30
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
31 Installation
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
32 ============
1782
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
33
6522
c4d3f0c208e9 mod_admin_web2: change mentions of admin_web to admin_web2
Menel <menel@snikket.de>
parents: 6520
diff changeset
34 1. Install the module like any other.
c4d3f0c208e9 mod_admin_web2: change mentions of admin_web to admin_web2
Menel <menel@snikket.de>
parents: 6520
diff changeset
35 2. **Execute the contained `get_deps.sh` script from within the admin\_web2
6507
73915ac32649 mod_admin_web: update comp and instruction.
Menel <menel@snikket.de>
parents: 5975
diff changeset
36 directory.** (Requires wget, tar, and a basic shell)
1782
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
37
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
38 Configuration Details
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
39 =====================
1782
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
40
6522
c4d3f0c208e9 mod_admin_web2: change mentions of admin_web to admin_web2
Menel <menel@snikket.de>
parents: 6520
diff changeset
41 "admin\_web2" needs to be added to the modules\_enabled table of the host
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
42 you want to load this module on.
1782
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
43
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
44 By default the interface will then be reachable under
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
45 `http://example.com:5280/admin`, or `https://example.com:5281/admin`.
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
46
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
47 The module will automatically enable two other modules if they aren't
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
48 already: mod\_bosh (used to connect to the server from the web), and
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
49 mod\_admin\_adhoc (which provides admin commands over XMPP).
1782
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
50
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
51 VirtualHost "example.com"
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
52 modules_enabled = {
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
53 .....
6522
c4d3f0c208e9 mod_admin_web2: change mentions of admin_web to admin_web2
Menel <menel@snikket.de>
parents: 6520
diff changeset
54 "admin_web2";
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
55 .....
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
56 }
1782
29f3d6b7ad16 Import wiki pages
Kim Alvefur <zash@zash.se>
parents:
diff changeset
57
1803
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
58 Compatibility
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
59 =============
4d73a1a6ba68 Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents: 1782
diff changeset
60
6520
7eb114975cec 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.
Menel <menel@snikket.de>
parents: 6507
diff changeset
61 --------- ----------------------------------
6507
73915ac32649 mod_admin_web: update comp and instruction.
Menel <menel@snikket.de>
parents: 5975
diff changeset
62 13.0 Works
6520
7eb114975cec 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.
Menel <menel@snikket.de>
parents: 6507
diff changeset
63 0.12 not supported, use [mod_admin_web]
7eb114975cec 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.
Menel <menel@snikket.de>
parents: 6507
diff changeset
64 \<= 0.11 not supported
7eb114975cec 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.
Menel <menel@snikket.de>
parents: 6507
diff changeset
65 --------- ----------------------------------