prosody-modules: mod_admin_web/README.md annotate

annotate mod_admin_web/README.md @ 6556:7477e97a9045

mod_firewall: Apply pre-reload state before re-reading config This change makes load/reload a bit more robust. module.load() runs before module.restore() and it reads from the config and updates the state (if needed). However, after this, module.restore() could run and apply the old state again.

author	Matthew Wild <mwild1@gmail.com>
date	Sun, 24 May 2026 20:03:20 +0100
parents	28e39dbf9d7b
children

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:
6521 28e39dbf9d7b mod_admin_web: update compability Menel <menel@snikket.de> parents: 6507 diff changeset	3 - 'Stage-Broken'
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
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 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
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
6521 28e39dbf9d7b mod_admin_web: update compability Menel <menel@snikket.de> parents: 6507 diff changeset	25 This module is broken for prosody >0.12 since it uses "is_admin"
28e39dbf9d7b mod_admin_web: update compability Menel <menel@snikket.de> parents: 6507 diff changeset	26
1803 4d73a1a6ba68 Convert all wiki pages to Markdown Kim Alvefur <zash@zash.se> parents: 1782 diff changeset	27 Installation
4d73a1a6ba68 Convert all wiki pages to Markdown Kim Alvefur <zash@zash.se> parents: 1782 diff changeset	28 ============
1782 29f3d6b7ad16 Import wiki pages Kim Alvefur <zash@zash.se> parents: diff changeset	29
1803 4d73a1a6ba68 Convert all wiki pages to Markdown Kim Alvefur <zash@zash.se> parents: 1782 diff changeset	30 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	31 for plugins. (cf. [Installing
4d73a1a6ba68 Convert all wiki pages to Markdown Kim Alvefur <zash@zash.se> parents: 1782 diff changeset	32 modules](http://prosody.im/doc/installing_modules))
6507 73915ac32649 mod_admin_web: update comp and instruction. Menel <menel@snikket.de> parents: 5975 diff changeset	33 2. **Execute the contained `get_deps.sh` script from within the admin\_web
73915ac32649 mod_admin_web: update comp and instruction. Menel <menel@snikket.de> parents: 5975 diff changeset	34 directory.** (Requires wget, tar, and a basic shell)
1782 29f3d6b7ad16 Import wiki pages Kim Alvefur <zash@zash.se> parents: diff changeset	35
1803 4d73a1a6ba68 Convert all wiki pages to Markdown Kim Alvefur <zash@zash.se> parents: 1782 diff changeset	36 Configuration Details
4d73a1a6ba68 Convert all wiki pages to Markdown Kim Alvefur <zash@zash.se> parents: 1782 diff changeset	37 =====================
1782 29f3d6b7ad16 Import wiki pages Kim Alvefur <zash@zash.se> parents: diff changeset	38
1803 4d73a1a6ba68 Convert all wiki pages to Markdown Kim Alvefur <zash@zash.se> parents: 1782 diff changeset	39 "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	40 you want to load this module on.
1782 29f3d6b7ad16 Import wiki pages Kim Alvefur <zash@zash.se> parents: diff changeset	41
1803 4d73a1a6ba68 Convert all wiki pages to Markdown Kim Alvefur <zash@zash.se> parents: 1782 diff changeset	42 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	43 `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	44
4d73a1a6ba68 Convert all wiki pages to Markdown Kim Alvefur <zash@zash.se> parents: 1782 diff changeset	45 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	46 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	47 mod\_admin\_adhoc (which provides admin commands over XMPP).
1782 29f3d6b7ad16 Import wiki pages Kim Alvefur <zash@zash.se> parents: diff changeset	48
1803 4d73a1a6ba68 Convert all wiki pages to Markdown Kim Alvefur <zash@zash.se> parents: 1782 diff changeset	49 VirtualHost "example.com"
4d73a1a6ba68 Convert all wiki pages to Markdown Kim Alvefur <zash@zash.se> parents: 1782 diff changeset	50 modules_enabled = {
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 "admin_web";
4d73a1a6ba68 Convert all wiki pages to Markdown Kim Alvefur <zash@zash.se> parents: 1782 diff changeset	53 .....
4d73a1a6ba68 Convert all wiki pages to Markdown Kim Alvefur <zash@zash.se> parents: 1782 diff changeset	54 }
1782 29f3d6b7ad16 Import wiki pages Kim Alvefur <zash@zash.se> parents: diff changeset	55
1803 4d73a1a6ba68 Convert all wiki pages to Markdown Kim Alvefur <zash@zash.se> parents: 1782 diff changeset	56 Compatibility
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
4d73a1a6ba68 Convert all wiki pages to Markdown Kim Alvefur <zash@zash.se> parents: 1782 diff changeset	59 --------- ---------------
6521 28e39dbf9d7b mod_admin_web: update compability Menel <menel@snikket.de> parents: 6507 diff changeset	60 13.0 broken
6507 73915ac32649 mod_admin_web: update comp and instruction. Menel <menel@snikket.de> parents: 5975 diff changeset	61 0.12 Works
73915ac32649 mod_admin_web: update comp and instruction. Menel <menel@snikket.de> parents: 5975 diff changeset	62 \<= 0.11 broken
1803 4d73a1a6ba68 Convert all wiki pages to Markdown Kim Alvefur <zash@zash.se> parents: 1782 diff changeset	63 --------- ---------------

Mercurial > prosody-modules

annotate mod_admin_web/README.md @ 6556:7477e97a9045