view mod_admin_notify/README.markdown @ 4719:5a06c711649c

mod_bookmarks2: Use max_items='max' on trunk, with fallback check_node_config() throws an error attempting to compare the pep_max_items number with the 'max' string, which allows detecting and support using 'max' where available. Unsure what happens when you upgrade, that seems a problem for a future commit! :)
author Kim Alvefur <zash@zash.se>
date Wed, 20 Oct 2021 22:16:14 +0200
parents e97c509fdbe3
children
line wrap: on
line source

---
labels:
- 'Stage-Alpha'
summary: API to notify server admins
---

# Introduction

This module provides an API for other module developers to send
notification messages to host admins.

# Configuration

None required.

# Developers

Example:

```
local notify_admins = module:depends("admin_notify").notify;

notify("This is an important message for you, admins")
```

# Compatibility

Prosody trunk or later. Incompatible with 0.11 or lower.