Software /
code /
prosody-modules
File
mod_http_index/README.markdown @ 5931:d194d1012fd3
Updating dox for mod_rest. Ideas expressed / clarified:
1) Making clear that mod_rest isn't to be installed under VirtualHosts AND as a component.
2) Understanding some of the implications of this choice:
A) Changes to user authentication
B) How it affects subdomains
3) More consistent use of domain names for clarity.
4) Using different heading sizes to show scope of section.
Essentially, I added all the tidbits I had to clarify in getting this to work in my
own example.
author | Ben Smith <bens@effortlessis.com> |
---|---|
date | Mon, 13 May 2024 13:25:13 -0700 |
parent | 3752:8992f84ca870 |
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" ```