view mod_http_index/README.markdown @ 1828:318f38d79ea9

mod_http_index: Add README file
author Kim Alvefur <zash@zash.se>
date Fri, 04 Sep 2015 00:29:08 +0200
parents
children 99a025dc4f6b
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 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"
```