Software /
code /
prosody-modules
Annotate
mod_admin_notify/README.markdown @ 5516:f25df3af02c1
mod_client_management: Include client software version number in listing
Should you ever wish to revoke a client by version number, e.g. for
security reasons affecting certain versions, then it would be good to at
the very least see which version is used.
Also includes the OAuth2 software ID, an optional unique identifier that
should be the same for all installations of a particular software.
author | Kim Alvefur <zash@zash.se> |
---|---|
date | Sat, 03 Jun 2023 19:21:39 +0200 |
parent | 4238:e97c509fdbe3 |
rev | line source |
---|---|
4238
e97c509fdbe3
mod_admin_notify: New module providing an API to notify host admins
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
1 --- |
e97c509fdbe3
mod_admin_notify: New module providing an API to notify host admins
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
2 labels: |
e97c509fdbe3
mod_admin_notify: New module providing an API to notify host admins
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
3 - 'Stage-Alpha' |
e97c509fdbe3
mod_admin_notify: New module providing an API to notify host admins
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
4 summary: API to notify server admins |
e97c509fdbe3
mod_admin_notify: New module providing an API to notify host admins
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
5 --- |
e97c509fdbe3
mod_admin_notify: New module providing an API to notify host admins
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
6 |
e97c509fdbe3
mod_admin_notify: New module providing an API to notify host admins
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
7 # Introduction |
e97c509fdbe3
mod_admin_notify: New module providing an API to notify host admins
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
8 |
e97c509fdbe3
mod_admin_notify: New module providing an API to notify host admins
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
9 This module provides an API for other module developers to send |
e97c509fdbe3
mod_admin_notify: New module providing an API to notify host admins
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
10 notification messages to host admins. |
e97c509fdbe3
mod_admin_notify: New module providing an API to notify host admins
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
11 |
e97c509fdbe3
mod_admin_notify: New module providing an API to notify host admins
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
12 # Configuration |
e97c509fdbe3
mod_admin_notify: New module providing an API to notify host admins
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
13 |
e97c509fdbe3
mod_admin_notify: New module providing an API to notify host admins
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
14 None required. |
e97c509fdbe3
mod_admin_notify: New module providing an API to notify host admins
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
15 |
e97c509fdbe3
mod_admin_notify: New module providing an API to notify host admins
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
16 # Developers |
e97c509fdbe3
mod_admin_notify: New module providing an API to notify host admins
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
17 |
e97c509fdbe3
mod_admin_notify: New module providing an API to notify host admins
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
18 Example: |
e97c509fdbe3
mod_admin_notify: New module providing an API to notify host admins
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
19 |
e97c509fdbe3
mod_admin_notify: New module providing an API to notify host admins
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
20 ``` |
e97c509fdbe3
mod_admin_notify: New module providing an API to notify host admins
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
21 local notify_admins = module:depends("admin_notify").notify; |
e97c509fdbe3
mod_admin_notify: New module providing an API to notify host admins
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
22 |
e97c509fdbe3
mod_admin_notify: New module providing an API to notify host admins
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
23 notify("This is an important message for you, admins") |
e97c509fdbe3
mod_admin_notify: New module providing an API to notify host admins
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
24 ``` |
e97c509fdbe3
mod_admin_notify: New module providing an API to notify host admins
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
25 |
e97c509fdbe3
mod_admin_notify: New module providing an API to notify host admins
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
26 # Compatibility |
e97c509fdbe3
mod_admin_notify: New module providing an API to notify host admins
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
27 |
e97c509fdbe3
mod_admin_notify: New module providing an API to notify host admins
Matthew Wild <mwild1@gmail.com>
parents:
diff
changeset
|
28 Prosody trunk or later. Incompatible with 0.11 or lower. |