changeset 502:3c81d8a9f1e2

Documentation for the new mod_admin_message module.
author mikael.berthe@gmail.com
date Sun, 25 Jan 2015 19:07:33 +0000
parents cd074071ac43
children a4637b24841a
files mod_admin_message.wiki
diffstat 1 files changed, 23 insertions(+), 0 deletions(-) [+]
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_admin_message.wiki	Sun Jan 25 19:07:33 2015 +0000
@@ -0,0 +1,23 @@
+#summary IM-based administration console
+
+= Introduction =
+
+This module provides a console over XMPP.
+All the commands of the mod_admin_telnet module are available from an XMPP client.
+
+Only the Prosody admins (see the _admins_ list in the Prosody configuration file) can use this console.
+
+= Installation =
+
+Copy the mod_admin_message directory into a directory Prosody will check for plugins (cf. [http://prosody.im/doc/installing_modules Installing modules]) and set up a component:
+
+{{{
+ Component "console@example.com" "admin_messageconsole"
+}}}
+
+"console@example.com" is the identifier of the XMPP console.
+
+= Compatibility =
+||trunk||Works||
+||0.9||Works||
+||<= 0.8||Not supported||
\ No newline at end of file