Diff

mod_admin_message/README.markdown @ 1803:4d73a1a6ba68

Convert all wiki pages to Markdown
author Kim Alvefur <zash@zash.se>
date Fri, 28 Aug 2015 18:03:58 +0200
parent 1782:29f3d6b7ad16
child 1820:8de50be756e5
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_admin_message/README.markdown	Fri Aug 28 18:03:58 2015 +0200
@@ -0,0 +1,35 @@
+---
+labels:
+- 'Stage-Beta'
+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. [Installing
+modules](http://prosody.im/doc/installing_modules)) and set up a
+component:
+
+     Component "console@example.com" "admin_message"
+
+"console@example.com" is the identifier of the XMPP console.
+
+Compatibility
+=============
+
+  --------- ---------------
+  trunk     Works
+  0.9       Works
+  \<= 0.8   Not supported
+  --------- ---------------