Software /
code /
prosody-modules
Annotate
mod_admin_web/README.markdown @ 5590:d5a31a13c357
mod_invites_register_web: Update doc on how to use `invites_html_template`.
author | Trần H. Trung <work@trung.fun> |
---|---|
date | Fri, 26 May 2023 02:08:29 +0700 |
parent | 4759:f649305d0bec |
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: |
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
3 - 'Stage-Beta' |
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 |
4181
fcc6b92869d4
mod_admin_web: Really fix luarocks build spec
Kim Alvefur <zash@zash.se>
parents:
4179
diff
changeset
|
10 build_command: cd admin_web; sh get_deps.sh |
fcc6b92869d4
mod_admin_web: Really fix luarocks build spec
Kim Alvefur <zash@zash.se>
parents:
4179
diff
changeset
|
11 install_command: | |
fcc6b92869d4
mod_admin_web: Really fix luarocks build spec
Kim Alvefur <zash@zash.se>
parents:
4179
diff
changeset
|
12 cd admin_web; |
fcc6b92869d4
mod_admin_web: Really fix luarocks build spec
Kim Alvefur <zash@zash.se>
parents:
4179
diff
changeset
|
13 cp mod_admin_web.lua $(LUADIR); |
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 | 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 | 19 |
1803
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
20 This module provides a basic web administration interface. It currently |
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
21 gives you access to Ad-Hoc commands on any virtual host or component |
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
22 that you are set as an administrator for in the Prosody config file. It |
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
23 also provides a live list of all S2S and C2S connections. |
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
24 |
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
25 Installation |
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
26 ============ |
1782 | 27 |
1803
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
28 1. Copy the admin\_web directory into a directory Prosody will check |
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
29 for plugins. (cf. [Installing |
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
30 modules](http://prosody.im/doc/installing_modules)) |
4759
f649305d0bec
mod_admin_web: make get_deps.sh stand out a little
Jonas Schäfer <jonas@wielicki.name>
parents:
4181
diff
changeset
|
31 2. Execute the contained `get_deps.sh` script from within the admin\_web |
1803
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
32 directory. (Requires wget, tar, and a basic shell) |
1782 | 33 |
1803
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
34 Configuration Details |
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
35 ===================== |
1782 | 36 |
1803
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
37 "admin\_web" needs to be added to the modules\_enabled table of the host |
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
38 you want to load this module on. |
1782 | 39 |
1803
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
40 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
|
41 `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
|
42 |
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
43 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
|
44 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
|
45 mod\_admin\_adhoc (which provides admin commands over XMPP). |
1782 | 46 |
1803
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
47 VirtualHost "example.com" |
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
48 modules_enabled = { |
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
49 ..... |
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
50 "admin_web"; |
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
51 ..... |
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
52 } |
1782 | 53 |
1803
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
54 Compatibility |
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 |
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
57 --------- --------------- |
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
58 trunk Works |
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
59 0.9 Works |
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
60 \<= 0.8 Not supported |
4d73a1a6ba68
Convert all wiki pages to Markdown
Kim Alvefur <zash@zash.se>
parents:
1782
diff
changeset
|
61 --------- --------------- |