File

mod_http_index/README.md @ 6325:6ea80b73d8f2

mod_http_oauth2: Only require redirect URIs when using grant types that need it In the Device flow, no redirect URI is used because the client instead receives responses by polling. It is therefore unnecessary to enforce a requirement that these include redirect URI(s).
author Kim Alvefur <zash@zash.se>
date Thu, 03 Jul 2025 15:42:42 +0200
parent 6003:fe081789f7b5
child 6211:750d64c47ec6
line wrap: on
line source

---
summary: Generate an index of local HTTP services
labels:
- Stage-Beta
rockspec:
  build:
    copy_directories:
    - html
---

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"
```