annotate mod_http_index/README.markdown @ 5128:7cc0f68b8715

mod_unified_push: Experimenal Unified Push provider
author Matthew Wild <mwild1@gmail.com>
date Thu, 05 Jan 2023 17:28:06 +0000
parents 8992f84ca870
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1828
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
2487
99a025dc4f6b mod_http_index/README: Linkify module names
Kim Alvefur <zash@zash.se>
parents: 1828
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: 1828
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: 1828
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: 1828
diff changeset
8 404 error usually) is boring, this might be the module for you! :)
1828
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 }
3751
cb9517827d76 mod_http_index/README: Split out advanced settings into its own section
Kim Alvefur <zash@zash.se>
parents: 2487
diff changeset
21 ```
1828
318f38d79ea9 mod_http_index: Add README file
Kim Alvefur <zash@zash.se>
parents:
diff changeset
22
3751
cb9517827d76 mod_http_index/README: Split out advanced settings into its own section
Kim Alvefur <zash@zash.se>
parents: 2487
diff changeset
23 # Advanced
cb9517827d76 mod_http_index/README: Split out advanced settings into its own section
Kim Alvefur <zash@zash.se>
parents: 2487
diff changeset
24
3752
8992f84ca870 mod_http_index: Only show http apps that include a title by default
Kim Alvefur <zash@zash.se>
parents: 3751
diff changeset
25 ## Listing all items
8992f84ca870 mod_http_index: Only show http apps that include a title by default
Kim Alvefur <zash@zash.se>
parents: 3751
diff changeset
26
8992f84ca870 mod_http_index: Only show http apps that include a title by default
Kim Alvefur <zash@zash.se>
parents: 3751
diff changeset
27 By default only HTTP apps that include a human-readable title are
8992f84ca870 mod_http_index: Only show http apps that include a title by default
Kim Alvefur <zash@zash.se>
parents: 3751
diff changeset
28 listed. This filtering can be disabled by setting:
8992f84ca870 mod_http_index: Only show http apps that include a title by default
Kim Alvefur <zash@zash.se>
parents: 3751
diff changeset
29
8992f84ca870 mod_http_index: Only show http apps that include a title by default
Kim Alvefur <zash@zash.se>
parents: 3751
diff changeset
30 ```lua
8992f84ca870 mod_http_index: Only show http apps that include a title by default
Kim Alvefur <zash@zash.se>
parents: 3751
diff changeset
31 http_index_list_all = true
8992f84ca870 mod_http_index: Only show http apps that include a title by default
Kim Alvefur <zash@zash.se>
parents: 3751
diff changeset
32 ```
8992f84ca870 mod_http_index: Only show http apps that include a title by default
Kim Alvefur <zash@zash.se>
parents: 3751
diff changeset
33
3751
cb9517827d76 mod_http_index/README: Split out advanced settings into its own section
Kim Alvefur <zash@zash.se>
parents: 2487
diff changeset
34 ## Template
cb9517827d76 mod_http_index/README: Split out advanced settings into its own section
Kim Alvefur <zash@zash.se>
parents: 2487
diff changeset
35
cb9517827d76 mod_http_index/README: Split out advanced settings into its own section
Kim Alvefur <zash@zash.se>
parents: 2487
diff changeset
36 The template can be customized by copying the included `http_index.html`
cb9517827d76 mod_http_index/README: Split out advanced settings into its own section
Kim Alvefur <zash@zash.se>
parents: 2487
diff changeset
37 and pointing to it with the `http_index_template` setting:
cb9517827d76 mod_http_index/README: Split out advanced settings into its own section
Kim Alvefur <zash@zash.se>
parents: 2487
diff changeset
38
cb9517827d76 mod_http_index/README: Split out advanced settings into its own section
Kim Alvefur <zash@zash.se>
parents: 2487
diff changeset
39 ``` lua
1828
318f38d79ea9 mod_http_index: Add README file
Kim Alvefur <zash@zash.se>
parents:
diff changeset
40 http_index_template = "/path/to/template.html"
318f38d79ea9 mod_http_index: Add README file
Kim Alvefur <zash@zash.se>
parents:
diff changeset
41 ```