Mercurial > prosody-modules
view mod_http_health/README.md @ 5715:8488ebde5739
mod_http_oauth2: Skip consent screen if requested by client and same scopes already granted
This follows the intent behind the OpenID Connect 'prompt' parameter
when it does not include the 'consent' keyword, that is the client
wishes to skip the consent screen. If the user has already granted the
exact same scopes to the exact same client in the past, then one can
assume that they may grant it again.
author | Kim Alvefur <zash@zash.se> |
---|---|
date | Tue, 14 Nov 2023 23:03:37 +0100 |
parents | 09233b625cb9 |
children |
line wrap: on
line source
Simple module adding an endpoint meant to be used for health checks. # Configuration After installing, enable by adding to [`modules_enabled`][doc:modules_enabled] like many other modules: ``` lua -- in the global section modules_enabled = { -- Other globally enabled modules here... "http_health"; -- add } ``` ## Access control By default only access via localhost is allowed. This can be adjusted with `http_health_allow_ips`. The following example shows the default: ``` http_health_allow_ips = { "::1"; "127.0.0.1" } ``` Access can also be granted to one IP range via CIDR notation: ``` http_health_allow_cidr = "172.17.2.0/24" ``` The default for `http_health_allow_cidr` is empty. # Details Adds a `http://your.prosody.example:5280/health` endpoint that returns either HTTP status code 200 when all appears to be good or 500 when any module [status][doc:developers:moduleapi#logging-and-status] has been set to `error`. # See also - [mod_measure_modules] provides module statues via OpenMetrics - [mod_http_status] provides all module status details as JSON via HTTP