Mercurial > prosody-modules
view mod_admin_notify/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 | 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.