Mercurial > prosody-modules
annotate mod_http_index/README.md @ 6319:04c3273cb81f
mod_auth_cyrus: Add empty 'profile' table to SASL handler objects
This is for compatibility with Prosody's built-in util.sasl objects.
A SASL profile table usually includes methods supported by the backend, which
can be used by SASL mechanism handlers to perform operations (such as testing
the password). It also optionally contains a 'cb' field with channel binding
method handlers.
The Cyrus backend doesn't support channel binding, and doesn't have the same
concept of auth backend methods (it handles all that internally, and Prosody
has no insight or control over it).
Thus, we create an empty profile which informs Prosody that the SASL handler
does not support any of the auth or channel binding methods. Some features
will not work, but they didn't work anyway. This just makes it explicit.
This fixes a traceback in mod_sasl2_fast, which expected SASL handlers to
always contain a 'profile' field.
| author | Matthew Wild <mwild1@gmail.com> |
|---|---|
| date | Thu, 04 Sep 2025 10:14:46 +0100 |
| parents | fe081789f7b5 |
| children |
| rev | line source |
|---|---|
|
5967
28b386fc7a05
mod_http_index: Add metadata to enable installation with plugin installer
Kim Alvefur <zash@zash.se>
parents:
3752
diff
changeset
|
1 --- |
|
28b386fc7a05
mod_http_index: Add metadata to enable installation with plugin installer
Kim Alvefur <zash@zash.se>
parents:
3752
diff
changeset
|
2 summary: Generate an index of local HTTP services |
|
28b386fc7a05
mod_http_index: Add metadata to enable installation with plugin installer
Kim Alvefur <zash@zash.se>
parents:
3752
diff
changeset
|
3 labels: |
|
28b386fc7a05
mod_http_index: Add metadata to enable installation with plugin installer
Kim Alvefur <zash@zash.se>
parents:
3752
diff
changeset
|
4 - Stage-Beta |
|
28b386fc7a05
mod_http_index: Add metadata to enable installation with plugin installer
Kim Alvefur <zash@zash.se>
parents:
3752
diff
changeset
|
5 rockspec: |
|
28b386fc7a05
mod_http_index: Add metadata to enable installation with plugin installer
Kim Alvefur <zash@zash.se>
parents:
3752
diff
changeset
|
6 build: |
|
28b386fc7a05
mod_http_index: Add metadata to enable installation with plugin installer
Kim Alvefur <zash@zash.se>
parents:
3752
diff
changeset
|
7 copy_directories: |
|
28b386fc7a05
mod_http_index: Add metadata to enable installation with plugin installer
Kim Alvefur <zash@zash.se>
parents:
3752
diff
changeset
|
8 - html |
|
28b386fc7a05
mod_http_index: Add metadata to enable installation with plugin installer
Kim Alvefur <zash@zash.se>
parents:
3752
diff
changeset
|
9 --- |
|
28b386fc7a05
mod_http_index: Add metadata to enable installation with plugin installer
Kim Alvefur <zash@zash.se>
parents:
3752
diff
changeset
|
10 |
| 1828 | 11 Introduction |
| 12 ============ | |
| 13 | |
| 14 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
|
15 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
|
16 [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
|
17 [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
|
18 404 error usually) is boring, this might be the module for you! :) |
| 1828 | 19 |
| 20 Configuration | |
| 21 ============= | |
| 22 | |
| 23 Install and enable like any other module. Also see [Prosodys HTTP | |
| 24 documentation](https://prosody.im/doc/http). | |
| 25 | |
| 26 ``` {.lua} | |
| 27 modules_enabled = { | |
| 28 -- other modules | |
| 29 "http_index"; | |
| 30 } | |
|
3751
cb9517827d76
mod_http_index/README: Split out advanced settings into its own section
Kim Alvefur <zash@zash.se>
parents:
2487
diff
changeset
|
31 ``` |
| 1828 | 32 |
|
3751
cb9517827d76
mod_http_index/README: Split out advanced settings into its own section
Kim Alvefur <zash@zash.se>
parents:
2487
diff
changeset
|
33 # Advanced |
|
cb9517827d76
mod_http_index/README: Split out advanced settings into its own section
Kim Alvefur <zash@zash.se>
parents:
2487
diff
changeset
|
34 |
|
3752
8992f84ca870
mod_http_index: Only show http apps that include a title by default
Kim Alvefur <zash@zash.se>
parents:
3751
diff
changeset
|
35 ## 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
|
36 |
|
8992f84ca870
mod_http_index: Only show http apps that include a title by default
Kim Alvefur <zash@zash.se>
parents:
3751
diff
changeset
|
37 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
|
38 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
|
39 |
|
8992f84ca870
mod_http_index: Only show http apps that include a title by default
Kim Alvefur <zash@zash.se>
parents:
3751
diff
changeset
|
40 ```lua |
|
8992f84ca870
mod_http_index: Only show http apps that include a title by default
Kim Alvefur <zash@zash.se>
parents:
3751
diff
changeset
|
41 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
|
42 ``` |
|
8992f84ca870
mod_http_index: Only show http apps that include a title by default
Kim Alvefur <zash@zash.se>
parents:
3751
diff
changeset
|
43 |
|
3751
cb9517827d76
mod_http_index/README: Split out advanced settings into its own section
Kim Alvefur <zash@zash.se>
parents:
2487
diff
changeset
|
44 ## Template |
|
cb9517827d76
mod_http_index/README: Split out advanced settings into its own section
Kim Alvefur <zash@zash.se>
parents:
2487
diff
changeset
|
45 |
|
cb9517827d76
mod_http_index/README: Split out advanced settings into its own section
Kim Alvefur <zash@zash.se>
parents:
2487
diff
changeset
|
46 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
|
47 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
|
48 |
|
cb9517827d76
mod_http_index/README: Split out advanced settings into its own section
Kim Alvefur <zash@zash.se>
parents:
2487
diff
changeset
|
49 ``` lua |
| 1828 | 50 http_index_template = "/path/to/template.html" |
| 51 ``` |
