prosody-modules
d872a1cd8c1d
mod_host_status_check/README.markdown
Software / code / prosody-modules
File
mod_host_status_check/README.markdown @ 5389:d872a1cd8c1d
mod_http_oauth2: Specify that 'contacts' items are emails in client registration
Not enforced, but good for documentation.
> Array of strings representing ways to contact people responsible for
> this client, typically email addresses.
"typically" isn't a great word in a specification, so one could persume
this may be e.g. URLs like https://example.com/contact-us or so as well.
| author | Kim Alvefur <zash@zash.se> |
|---|---|
| date | Sun, 30 Apr 2023 15:20:05 +0200 |
| parent | 2241:2a16a6c67288 |
| child | 5923:694b62d8a82f |
line wrap: on
line source
--- labels: Stage-Beta summary: Host status check ... Introduction ============ This module allows you to monitor the state of hosts and components in your Prosody server. For example, it will track whether components are connected and (if the component supports it) listen for heartbeats sent by the component to indicate that it is functioning. This module does not expose any interface to access the status information itself. See [mod\_http\_host\_status\_check] for a module that allows you to access host status information over HTTP(S). Configuration ============= There are no configuration options for this module. You should enable it on every host that you want to monitor, by adding it to modules\_enabled. Note that to monitor components, adding to the global modules\_enabled list will not suffice - you will need to add it to the component's own modules\_enabled, like this: ``` {.lua} Component "mycomponent.example.com" modules_enabled = { "host_status_check" } ``` Compatibility ============= Works with Prosody 0.9.x and later.
