diff mod_admin_web2/README.md @ 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.
author Menel <menel@snikket.de>
date Fri, 24 Apr 2026 12:40:13 +0200
parents mod_admin_web/README.md@73915ac32649
children c4d3f0c208e9
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_admin_web2/README.md	Fri Apr 24 12:40:13 2026 +0200
@@ -0,0 +1,67 @@
+---
+labels:
+- 'Stage-Alpha'
+summary: Web administration interface
+rockspec:
+  build:
+    platforms:
+      unix:
+        type: command
+        build_command: cd admin_web2; sh get_deps.sh
+        install_command: |
+          cd admin_web2;
+          cp mod_admin_web2.lua $(LUADIR);
+          cp -r www_files $(PREFIX);
+...
+
+Introduction
+============
+
+This module is a fork of [mod_admin_web], because that on is incompatible with prosody 13.0.
+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.
+Patches welcome.
+
+This module provides a basic web-administration interface. It currently
+gives you access to Ad-Hoc commands on any virtual host or component. It
+also provides a live list of S2S and C2S connections. (buggy, not showing all of them)
+
+**New:** You need to be the global instance operator to access this module. Smiplifying access rights.
+**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.
+
+Installation
+============
+
+1.  Copy the admin\_web directory into a directory Prosody will check
+    for plugins. (cf. [Installing
+    modules](http://prosody.im/doc/installing_modules))
+2.  **Execute the contained `get_deps.sh` script from within the admin\_web
+    directory.** (Requires wget, tar, and a basic shell)
+
+Configuration Details
+=====================
+
+"admin\_web" needs to be added to the modules\_enabled table of the host
+you want to load this module on.
+
+By default the interface will then be reachable under
+`http://example.com:5280/admin`, or `https://example.com:5281/admin`.
+
+The module will automatically enable two other modules if they aren't
+already: mod\_bosh (used to connect to the server from the web), and
+mod\_admin\_adhoc (which provides admin commands over XMPP).
+
+    VirtualHost "example.com"
+       modules_enabled = {
+           .....
+           "admin_web";
+           .....
+       }
+
+Compatibility
+=============
+
+  --------- ----------------------------------
+  13.0      Works
+  0.12      not supported, use [mod_admin_web]
+  \<= 0.11  not supported
+  --------- ----------------------------------