annotate mod_http_index/README.md @ 6261:1c62edeb9147

mod_pastebin: Update Readme diff --git a/mod_pastebin/README.md b/mod_pastebin/README.md --- a/mod_pastebin/README.md +++ b/mod_pastebin/README.md @@ -37,12 +37,14 @@ For example: Pastes will be available by default at `http://<your-prosody>:5280/pastebin/` by default. -In Prosody 0.9 and later this can be changed with [HTTP -settings](https://prosody.im/doc/http). +Ports and path can be changed with [HTTP +settings](https://prosody.im/doc/http), for example like: -In 0.8 and older this can be changed with `pastebin_ports` (see below), -or you can forward another external URL from your web server to Prosody, -use `pastebin_url` to set that URL. +``` {.lua} + http_paths = { + pastebin = "/$host-paste"; + } +``` # Discovery @@ -82,27 +84,16 @@ The line and character tresholds are adv pastebin_line_threshold The maximum number of lines a message may have before it is sent to the pastebin. (default 4 lines) pastebin_trigger A string of characters (e.g. "!paste ") which if detected at the start of a message, always sends the message to the pastebin, regardless of length. (default: not set) pastebin_expire_after Number of hours after which to expire (remove) a paste, defaults to 24. Set to 0 to store pastes permanently on disk. - pastebin_ports List of ports to run the HTTP server on, same format as mod_httpserver's http_ports[^1] - pastebin_url Base URL to display for pastebin links, must end with / and redirect to Prosody's built-in HTTP server[^2] # Compatibility - ------ ------- - trunk Works + ------ --------------------- + trunk Works as of 25-06-13 + 13 Works 0.12 Works - 0.11 Works - 0.10 Works - 0.9 Works - 0.8 Works - ------ ------- + ------ --------------------- # Todo - Maximum paste length - Web interface to submit pastes? - -[^1]: As of Prosody 0.9, `pastebin_ports` is replaced by `http_ports`, - see [Prosody HTTP server documentation](https://prosody.im/doc/http) - -[^2]: See also - [http_external_url](https://prosody.im/doc/http#external_url)
author Menel <menel@snikket.de>
date Fri, 13 Jun 2025 11:39:58 +0200
parents fe081789f7b5
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
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
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 ```