# HG changeset patch
# User florob@babelmonkeys.de
# Date 1304706457 0
# Node ID 9c5790cbea36057a86663f6de825610c464f2034
# Parent  c33d7df822ff9a77d49bf0b6a230dc3e761e26a9
(Finally) added some documentation for mod_admin_web.

diff -r c33d7df822ff -r 9c5790cbea36 mod_admin_web.wiki
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_admin_web.wiki	Fri May 06 18:27:37 2011 +0000
@@ -0,0 +1,30 @@
+#summary Web administration interface
+#labels Stage-Beta
+= Introduction =
+
+This module provides a very basic web administration interface.
+It currently gives you access to Ad-Hoc commands on any virtual host you are administrator for. It also provides a live list of all S2S and C2S connections.
+
+
+= Installation =
+
+Copy the admin_web directory into prosody's plugin directory and execute the contained get_deps.sh script. This will require wget, tar, make 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. The port can optionally be specified with the webadmin_http_ports option.
+By default the interface will then be reachable under `http://example.com:5280/admin`.
+{{{
+Host "example.com"
+   modules_enabled = {
+       .....
+       "admin_web";
+       .....
+   }
+
+   webadmin_http_ports = { 8080 };
+}}}
+
+= Compatibility =
+||0.8||Works||
+||To be 0.9||Works||
\ No newline at end of file