Mercurial > prosody-modules
view mod_http_index/README.markdown @ 4776:13e913471b75
mod_http_admin_api: Ensure freshness of metrics when in manual mode
When in manual collection mode, as recommended for Prometheus,
collection needs to be triggered manually, or they would be stale,
possibly dating from the start of the server. This might vary per metric
depending on how and when the metrics are gathered.
author | Kim Alvefur <zash@zash.se> |
---|---|
date | Thu, 18 Nov 2021 19:26:07 +0100 |
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" ```