mod_http_index/README.markdown
author Kim Alvefur <zash@zash.se>
Tue, 07 Feb 2017 09:57:58 +0100
changeset 2491 99a025dc4f6b
parent 1832 318f38d79ea9
child 3755 cb9517827d76
permissions -rw-r--r--
mod_http_index/README: Linkify module names
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
1832
318f38d79ea9 mod_http_index: Add README file
Kim Alvefur <zash@zash.se>
parents:
diff changeset
     1
Introduction
318f38d79ea9 mod_http_index: Add README file
Kim Alvefur <zash@zash.se>
parents:
diff changeset
     2
============
318f38d79ea9 mod_http_index: Add README file
Kim Alvefur <zash@zash.se>
parents:
diff changeset
     3
318f38d79ea9 mod_http_index: Add README file
Kim Alvefur <zash@zash.se>
parents:
diff changeset
     4
This module produces a list of enabled HTTP "apps" exposed from Prosody
2491
99a025dc4f6b mod_http_index/README: Linkify module names
Kim Alvefur <zash@zash.se>
parents: 1832
diff changeset
     5
at `http://example.org:5280/`, e.g. [mod\_http\_muc\_log],
99a025dc4f6b mod_http_index/README: Linkify module names
Kim Alvefur <zash@zash.se>
parents: 1832
diff changeset
     6
[mod\_http\_files][doc:modules:mod_http_files] or
99a025dc4f6b mod_http_index/README: Linkify module names
Kim Alvefur <zash@zash.se>
parents: 1832
diff changeset
     7
[mod\_admin\_web]. If you think Prosodys default "root" web page (a
99a025dc4f6b mod_http_index/README: Linkify module names
Kim Alvefur <zash@zash.se>
parents: 1832
diff changeset
     8
404 error usually) is boring, this might be the module for you! :)
1832
318f38d79ea9 mod_http_index: Add README file
Kim Alvefur <zash@zash.se>
parents:
diff changeset
     9
318f38d79ea9 mod_http_index: Add README file
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    10
Configuration
318f38d79ea9 mod_http_index: Add README file
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    11
=============
318f38d79ea9 mod_http_index: Add README file
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    12
318f38d79ea9 mod_http_index: Add README file
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    13
Install and enable like any other module. Also see [Prosodys HTTP
318f38d79ea9 mod_http_index: Add README file
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    14
documentation](https://prosody.im/doc/http).
318f38d79ea9 mod_http_index: Add README file
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    15
318f38d79ea9 mod_http_index: Add README file
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    16
``` {.lua}
318f38d79ea9 mod_http_index: Add README file
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    17
modules_enabled = {
318f38d79ea9 mod_http_index: Add README file
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    18
  -- other modules
318f38d79ea9 mod_http_index: Add README file
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    19
  "http_index";
318f38d79ea9 mod_http_index: Add README file
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    20
}
318f38d79ea9 mod_http_index: Add README file
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    21
318f38d79ea9 mod_http_index: Add README file
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    22
-- optional, defaults to a file next to the module
318f38d79ea9 mod_http_index: Add README file
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    23
http_index_template = "/path/to/template.html"
318f38d79ea9 mod_http_index: Add README file
Kim Alvefur <zash@zash.se>
parents:
diff changeset
    24
```