prosody-modules
d611ed13df7e
mod_http_index/README.md

Find changesets by keywords by author, files, the commit message, revision number or hash, or revset expression.

Software / code / prosody-modules

Annotate

mod_http_index/README.md @ 6209:d611ed13df7e draft

Merge
author Trần H. Trung <xmpp:trần.h.trung@trung.fun>
date Tue, 18 Mar 2025 00:16:25 +0700
child 6211:750d64c47ec6
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6209
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
1 ---
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
2 summary: Generate an index of local HTTP services
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
3 labels:
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
4 - Stage-Beta
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
5 rockspec:
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
6 build:
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
7 copy_directories:
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
8 - html
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
9 ---
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
10
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
11 Introduction
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
12 ============
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
13
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
14 This module produces a list of enabled HTTP "apps" exposed from Prosody
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
15 at `http://example.org:5280/`, e.g. [mod\_http\_muc\_log],
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
16 [mod\_http\_files][doc:modules:mod_http_files] or
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
17 [mod\_admin\_web]. If you think Prosodys default "root" web page (a
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
18 404 error usually) is boring, this might be the module for you! :)
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
19
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
20 Configuration
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
21 =============
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
22
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
23 Install and enable like any other module. Also see [Prosodys HTTP
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
24 documentation](https://prosody.im/doc/http).
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
25
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
26 ``` {.lua}
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
27 modules_enabled = {
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
28 -- other modules
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
29 "http_index";
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
30 }
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
31 ```
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
32
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
33 # Advanced
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
34
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
35 ## Listing all items
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
36
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
37 By default only HTTP apps that include a human-readable title are
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
38 listed. This filtering can be disabled by setting:
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
39
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
40 ```lua
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
41 http_index_list_all = true
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
42 ```
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
43
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
44 ## Template
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
45
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
46 The template can be customized by copying the included `http_index.html`
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
47 and pointing to it with the `http_index_template` setting:
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
48
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
49 ``` lua
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
50 http_index_template = "/path/to/template.html"
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
51 ```