view mod_http_index/README.markdown @ 5215:fd6cb4365438

mod_cloud_notify: Log warning when used on Lua 5.1
author Matthew Wild <mwild1@gmail.com>
date Tue, 07 Mar 2023 10:24:58 +0000
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"
```