view mod_admin_message/README.markdown @ 5907:d194d1012fd3

Updating dox for mod_rest. Ideas expressed / clarified: 1) Making clear that mod_rest isn't to be installed under VirtualHosts AND as a component. 2) Understanding some of the implications of this choice: A) Changes to user authentication B) How it affects subdomains 3) More consistent use of domain names for clarity. 4) Using different heading sizes to show scope of section. Essentially, I added all the tidbits I had to clarify in getting this to work in my own example.
author Ben Smith <bens@effortlessis.com>
date Mon, 13 May 2024 13:25:13 -0700
parents 34fb3d239ac1
children
line wrap: on
line source

---
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     Doesn't work (uses is_admin)
  0.9       Works
  \<= 0.8   Not supported
  --------- ---------------