Mercurial > prosody-modules
annotate mod_http_index/README.markdown @ 4876:0f5f2d4475b9
mod_http_xep227: Add support for import via APIs rather than direct store manipulation
In particular this transitions PEP nodes and data to be imported via mod_pep's
APIs, fixing issues with importing at runtime while PEP data may already be
live in RAM.
Next obvious candidate for this approach is rosters, so clients get immediate
roster pushes and other special handling (such as emitting subscribes to reach
the desired subscription state).
| author | Matthew Wild <mwild1@gmail.com> |
|---|---|
| date | Tue, 18 Jan 2022 17:01:18 +0000 |
| parents | 8992f84ca870 |
| children |
| rev | line source |
|---|---|
| 1828 | 1 Introduction |
| 2 ============ | |
| 3 | |
| 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 | 9 |
| 10 Configuration | |
| 11 ============= | |
| 12 | |
| 13 Install and enable like any other module. Also see [Prosodys HTTP | |
| 14 documentation](https://prosody.im/doc/http). | |
| 15 | |
| 16 ``` {.lua} | |
| 17 modules_enabled = { | |
| 18 -- other modules | |
| 19 "http_index"; | |
| 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 | 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 | 40 http_index_template = "/path/to/template.html" |
| 41 ``` |