view mod_http_index/README.markdown @ 2598:d9022fe9749c

luacheckrc: List module instance fields
author Kim Alvefur <zash@zash.se>
date Mon, 06 Mar 2017 00:43:22 +0100
parents 99a025dc4f6b
children cb9517827d76
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";
}

-- optional, defaults to a file next to the module
http_index_template = "/path/to/template.html"
```