Software `/` code `/` prosody-modules

Annotate

mod_http_index/README.md @ 6055:23c4c61a1068

mod_muc_gateway_optimize: New module to optimize muc presence to remote gateways Some gateways are happy to receive presence for each participant in MUCs that they are in only once, to any one of their joined JIDs.

author	Stephen Paul Weber <singpolyma@singpolyma.net>
date	Sun, 17 Nov 2024 22:32:52 -0500
parent	6003:fe081789f7b5
child	6211:750d64c47ec6

rev	line source
5995 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 318f38d79ea9 mod_http_index: Add README file Kim Alvefur <zash@zash.se> parents: diff changeset	11 Introduction
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
318f38d79ea9 mod_http_index: Add README file Kim Alvefur <zash@zash.se> parents: diff changeset	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 318f38d79ea9 mod_http_index: Add README file Kim Alvefur <zash@zash.se> parents: diff changeset	19
318f38d79ea9 mod_http_index: Add README file Kim Alvefur <zash@zash.se> parents: diff changeset	20 Configuration
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
318f38d79ea9 mod_http_index: Add README file Kim Alvefur <zash@zash.se> parents: diff changeset	23 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	24 documentation](https://prosody.im/doc/http).
318f38d79ea9 mod_http_index: Add README file Kim Alvefur <zash@zash.se> parents: diff changeset	25
318f38d79ea9 mod_http_index: Add README file Kim Alvefur <zash@zash.se> parents: diff changeset	26 ``` {.lua}
318f38d79ea9 mod_http_index: Add README file Kim Alvefur <zash@zash.se> parents: diff changeset	27 modules_enabled = {
318f38d79ea9 mod_http_index: Add README file Kim Alvefur <zash@zash.se> parents: diff changeset	28 -- other modules
318f38d79ea9 mod_http_index: Add README file Kim Alvefur <zash@zash.se> parents: diff changeset	29 "http_index";
318f38d79ea9 mod_http_index: Add README file Kim Alvefur <zash@zash.se> parents: diff changeset	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 318f38d79ea9 mod_http_index: Add README file Kim Alvefur <zash@zash.se> parents: diff changeset	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 318f38d79ea9 mod_http_index: Add README file Kim Alvefur <zash@zash.se> parents: diff changeset	50 http_index_template = "/path/to/template.html"
318f38d79ea9 mod_http_index: Add README file Kim Alvefur <zash@zash.se> parents: diff changeset	51 ```

prosody-modules

23c4c61a1068

mod_http_index/README.md

Software / code / prosody-modules

Annotate

mod_http_index/README.md @ 6055:23c4c61a1068

Software `/` code `/` prosody-modules