prosody-modules: mod_host_status_check/README.markdown annotate

annotate mod_host_status_check/README.markdown @ 5160:8474a3b80200

mod_firewall: Fix 'is_admin' internal dependency rule #1797 (thanks diane) Looks like the boolean logic was inverted here. Instead, for now, simply check if is_admin is there. It is deprecated in trunk and was briefly removed before being brought back with a 'deprecated' warning as part of the new roles and permissions work. Making this dependency conditioned on the existence of the underlying function should make it work until it actually goes away for real.

author	Kim Alvefur <zash@zash.se>
date	Fri, 27 Jan 2023 23:06:25 +0100
parents	2a16a6c67288
children	694b62d8a82f

rev	line source
2219 5fcf9d558250 Three new modules: mod_host_status_check, mod_host_status_heartbeat and mod_http_host_status_check Matthew Wild <mwild1@gmail.com> parents: diff changeset	1 ---
5fcf9d558250 Three new modules: mod_host_status_check, mod_host_status_heartbeat and mod_http_host_status_check Matthew Wild <mwild1@gmail.com> parents: diff changeset	2 labels: Stage-Beta
2230 42eafc1c61d9 Correct short description key to 'summary' Kim Alvefur <zash@zash.se> parents: 2219 diff changeset	3 summary: Host status check
2219 5fcf9d558250 Three new modules: mod_host_status_check, mod_host_status_heartbeat and mod_http_host_status_check Matthew Wild <mwild1@gmail.com> parents: diff changeset	4 ...
5fcf9d558250 Three new modules: mod_host_status_check, mod_host_status_heartbeat and mod_http_host_status_check Matthew Wild <mwild1@gmail.com> parents: diff changeset	5
5fcf9d558250 Three new modules: mod_host_status_check, mod_host_status_heartbeat and mod_http_host_status_check Matthew Wild <mwild1@gmail.com> parents: diff changeset	6 Introduction
5fcf9d558250 Three new modules: mod_host_status_check, mod_host_status_heartbeat and mod_http_host_status_check Matthew Wild <mwild1@gmail.com> parents: diff changeset	7 ============
5fcf9d558250 Three new modules: mod_host_status_check, mod_host_status_heartbeat and mod_http_host_status_check Matthew Wild <mwild1@gmail.com> parents: diff changeset	8
5fcf9d558250 Three new modules: mod_host_status_check, mod_host_status_heartbeat and mod_http_host_status_check Matthew Wild <mwild1@gmail.com> parents: diff changeset	9 This module allows you to monitor the state of hosts and components in your Prosody server. For example,
5fcf9d558250 Three new modules: mod_host_status_check, mod_host_status_heartbeat and mod_http_host_status_check Matthew Wild <mwild1@gmail.com> parents: diff changeset	10 it will track whether components are connected and (if the component supports it) listen for heartbeats
5fcf9d558250 Three new modules: mod_host_status_check, mod_host_status_heartbeat and mod_http_host_status_check Matthew Wild <mwild1@gmail.com> parents: diff changeset	11 sent by the component to indicate that it is functioning.
5fcf9d558250 Three new modules: mod_host_status_check, mod_host_status_heartbeat and mod_http_host_status_check Matthew Wild <mwild1@gmail.com> parents: diff changeset	12
2241 2a16a6c67288 mod_host_status_check/README: Linkify module names Kim Alvefur <zash@zash.se> parents: 2230 diff changeset	13 This module does not expose any interface to access the status information itself. See [mod\_http\_host\_status\_check]
2219 5fcf9d558250 Three new modules: mod_host_status_check, mod_host_status_heartbeat and mod_http_host_status_check Matthew Wild <mwild1@gmail.com> parents: diff changeset	14 for a module that allows you to access host status information over HTTP(S).
5fcf9d558250 Three new modules: mod_host_status_check, mod_host_status_heartbeat and mod_http_host_status_check Matthew Wild <mwild1@gmail.com> parents: diff changeset	15
5fcf9d558250 Three new modules: mod_host_status_check, mod_host_status_heartbeat and mod_http_host_status_check Matthew Wild <mwild1@gmail.com> parents: diff changeset	16 Configuration
5fcf9d558250 Three new modules: mod_host_status_check, mod_host_status_heartbeat and mod_http_host_status_check Matthew Wild <mwild1@gmail.com> parents: diff changeset	17 =============
5fcf9d558250 Three new modules: mod_host_status_check, mod_host_status_heartbeat and mod_http_host_status_check Matthew Wild <mwild1@gmail.com> parents: diff changeset	18
5fcf9d558250 Three new modules: mod_host_status_check, mod_host_status_heartbeat and mod_http_host_status_check Matthew Wild <mwild1@gmail.com> parents: diff changeset	19 There are no configuration options for this module.
5fcf9d558250 Three new modules: mod_host_status_check, mod_host_status_heartbeat and mod_http_host_status_check Matthew Wild <mwild1@gmail.com> parents: diff changeset	20
5fcf9d558250 Three new modules: mod_host_status_check, mod_host_status_heartbeat and mod_http_host_status_check Matthew Wild <mwild1@gmail.com> parents: diff changeset	21 You should enable it on every host that you want to monitor, by adding it to modules\_enabled. Note
5fcf9d558250 Three new modules: mod_host_status_check, mod_host_status_heartbeat and mod_http_host_status_check Matthew Wild <mwild1@gmail.com> parents: diff changeset	22 that to monitor components, adding to the global modules\_enabled list will not suffice - you will
5fcf9d558250 Three new modules: mod_host_status_check, mod_host_status_heartbeat and mod_http_host_status_check Matthew Wild <mwild1@gmail.com> parents: diff changeset	23 need to add it to the component's own modules\_enabled, like this:
5fcf9d558250 Three new modules: mod_host_status_check, mod_host_status_heartbeat and mod_http_host_status_check Matthew Wild <mwild1@gmail.com> parents: diff changeset	24
5fcf9d558250 Three new modules: mod_host_status_check, mod_host_status_heartbeat and mod_http_host_status_check Matthew Wild <mwild1@gmail.com> parents: diff changeset	25 ``` {.lua}
5fcf9d558250 Three new modules: mod_host_status_check, mod_host_status_heartbeat and mod_http_host_status_check Matthew Wild <mwild1@gmail.com> parents: diff changeset	26 Component "mycomponent.example.com"
5fcf9d558250 Three new modules: mod_host_status_check, mod_host_status_heartbeat and mod_http_host_status_check Matthew Wild <mwild1@gmail.com> parents: diff changeset	27 modules_enabled = { "host_status_check" }
5fcf9d558250 Three new modules: mod_host_status_check, mod_host_status_heartbeat and mod_http_host_status_check Matthew Wild <mwild1@gmail.com> parents: diff changeset	28 ```
5fcf9d558250 Three new modules: mod_host_status_check, mod_host_status_heartbeat and mod_http_host_status_check Matthew Wild <mwild1@gmail.com> parents: diff changeset	29
5fcf9d558250 Three new modules: mod_host_status_check, mod_host_status_heartbeat and mod_http_host_status_check Matthew Wild <mwild1@gmail.com> parents: diff changeset	30 Compatibility
5fcf9d558250 Three new modules: mod_host_status_check, mod_host_status_heartbeat and mod_http_host_status_check Matthew Wild <mwild1@gmail.com> parents: diff changeset	31 =============
5fcf9d558250 Three new modules: mod_host_status_check, mod_host_status_heartbeat and mod_http_host_status_check Matthew Wild <mwild1@gmail.com> parents: diff changeset	32
5fcf9d558250 Three new modules: mod_host_status_check, mod_host_status_heartbeat and mod_http_host_status_check Matthew Wild <mwild1@gmail.com> parents: diff changeset	33 Works with Prosody 0.9.x and later.

Mercurial > prosody-modules

annotate mod_host_status_check/README.markdown @ 5160:8474a3b80200