annotate mod_persisthosts/README.markdown @ 5668:ecfd7aece33b

mod_measure_modules: Report module statuses via OpenMetrics Someone in the chat asked about a health check endpoint, which reminded me of mod_http_status, which provides access to module statuses with full details. After that, this idea came about, which seems natural. As noted in the README, it could be used to monitor that critical modules are in fact loaded correctly. As more modules use the status API, the more useful this module and mod_http_status becomes.
author Kim Alvefur <zash@zash.se>
date Fri, 06 Oct 2023 18:34:39 +0200
parents 81956bb99289
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2446
c563f4d64302 mod_persisthosts: Module that dynamically creates stub configuration files for dynamically activated hosts
Kim Alvefur <zash@zash.se>
parents:
diff changeset
1 Introduction
c563f4d64302 mod_persisthosts: Module that dynamically creates stub configuration files for dynamically activated hosts
Kim Alvefur <zash@zash.se>
parents:
diff changeset
2 ============
c563f4d64302 mod_persisthosts: Module that dynamically creates stub configuration files for dynamically activated hosts
Kim Alvefur <zash@zash.se>
parents:
diff changeset
3
c563f4d64302 mod_persisthosts: Module that dynamically creates stub configuration files for dynamically activated hosts
Kim Alvefur <zash@zash.se>
parents:
diff changeset
4 This module creates stub configuration files for newly activated hosts.
c563f4d64302 mod_persisthosts: Module that dynamically creates stub configuration files for dynamically activated hosts
Kim Alvefur <zash@zash.se>
parents:
diff changeset
5
c563f4d64302 mod_persisthosts: Module that dynamically creates stub configuration files for dynamically activated hosts
Kim Alvefur <zash@zash.se>
parents:
diff changeset
6 Configuration
c563f4d64302 mod_persisthosts: Module that dynamically creates stub configuration files for dynamically activated hosts
Kim Alvefur <zash@zash.se>
parents:
diff changeset
7 =============
c563f4d64302 mod_persisthosts: Module that dynamically creates stub configuration files for dynamically activated hosts
Kim Alvefur <zash@zash.se>
parents:
diff changeset
8
c563f4d64302 mod_persisthosts: Module that dynamically creates stub configuration files for dynamically activated hosts
Kim Alvefur <zash@zash.se>
parents:
diff changeset
9 A single option exists, `persisthosts_path`, which is the path where new
c563f4d64302 mod_persisthosts: Module that dynamically creates stub configuration files for dynamically activated hosts
Kim Alvefur <zash@zash.se>
parents:
diff changeset
10 stub configuration files are created. It defaults to `"conf.d"`, and is
c563f4d64302 mod_persisthosts: Module that dynamically creates stub configuration files for dynamically activated hosts
Kim Alvefur <zash@zash.se>
parents:
diff changeset
11 treated as relative to the configuration directiory [^1] unless set to
c563f4d64302 mod_persisthosts: Module that dynamically creates stub configuration files for dynamically activated hosts
Kim Alvefur <zash@zash.se>
parents:
diff changeset
12 an absolute path.
c563f4d64302 mod_persisthosts: Module that dynamically creates stub configuration files for dynamically activated hosts
Kim Alvefur <zash@zash.se>
parents:
diff changeset
13
2485
81956bb99289 mod_persisthosts/README: Fix formatting
Kim Alvefur <zash@zash.se>
parents: 2446
diff changeset
14 [^1]: usually `/etc/prosody` on \*nix systems