view mod_support_contact/README.markdown @ 5668:ecfd7aece33b

mod_measure_modules: Report module statuses via OpenMetrics Someone in the chat asked about a health check endpoint, which reminded me of mod_http_status, which provides access to module statuses with full details. After that, this idea came about, which seems natural. As noted in the README, it could be used to monitor that critical modules are in fact loaded correctly. As more modules use the status API, the more useful this module and mod_http_status becomes.
author Kim Alvefur <zash@zash.se>
date Fri, 06 Oct 2023 18:34:39 +0200
parents dd509940ae49
children
line wrap: on
line source

---
labels:
- 'Stage-Stable'
summary: Add a support contact to new registrations
...

Introduction
============

This Prosody plugin adds a default contact to newly registered accounts.

Usage
=====

Simply add "support\_contact" to your modules\_enabled list. When a new
account is created, the new roster would be initialized to include a
support contact.

Configuration
=============

  ------------------------- --------------------------------------------------------------------------------------------------------------------------------
  support\_contact          The bare JID of the support contact. The default is support@hostname, where hostname is the host the new user's account is on.
  support\_contact\_nick    Nickname of the support contact. The default is "Support".
  support\_contact\_group   The roster group in the support contact's roster in which to add the new user.
  ------------------------- --------------------------------------------------------------------------------------------------------------------------------

Compatibility
=============

  ------ -------
  0.10   Works
  0.9    Works
  0.8    Works
  0.7    Works
  0.6    Works
  ------ -------

**For 0.8 and older** use [version
999a4b3e699b](http://hg.prosody.im/prosody-modules/file/999a4b3e699b/mod_support_contact/mod_support_contact.lua).

Caveats/Todos/Bugs
==================

-   This only works for accounts created via in-band registration.