Mercurial > prosody-modules
view mod_http_index/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 | 8992f84ca870 |
children |
line wrap: on
line source
Introduction ============ This module produces a list of enabled HTTP "apps" exposed from Prosody at `http://example.org:5280/`, e.g. [mod\_http\_muc\_log], [mod\_http\_files][doc:modules:mod_http_files] or [mod\_admin\_web]. If you think Prosodys default "root" web page (a 404 error usually) is boring, this might be the module for you! :) Configuration ============= Install and enable like any other module. Also see [Prosodys HTTP documentation](https://prosody.im/doc/http). ``` {.lua} modules_enabled = { -- other modules "http_index"; } ``` # Advanced ## Listing all items By default only HTTP apps that include a human-readable title are listed. This filtering can be disabled by setting: ```lua http_index_list_all = true ``` ## Template The template can be customized by copying the included `http_index.html` and pointing to it with the `http_index_template` setting: ``` lua http_index_template = "/path/to/template.html" ```