prosody-modules
1c62edeb9147
mod_pastebin/README.md

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

Software / code / prosody-modules

Comparison

mod_pastebin/README.md @ 6305: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
parent 6000:51b6a10b50d2
child 6306:fe0a58b863db
comparison
equal deleted inserted replaced
6304:6c484931c547 6305:1c62edeb9147
35 modules_enabled = { "pastebin" } 35 modules_enabled = { "pastebin" }
36 36
37 Pastes will be available by default at 37 Pastes will be available by default at
38 `http://<your-prosody>:5280/pastebin/` by default. 38 `http://<your-prosody>:5280/pastebin/` by default.
39 39
40 In Prosody 0.9 and later this can be changed with [HTTP 40 Ports and path can be changed with [HTTP
41 settings](https://prosody.im/doc/http). 41 settings](https://prosody.im/doc/http), for example like:
42 42
43 In 0.8 and older this can be changed with `pastebin_ports` (see below), 43 ``` {.lua}
44 or you can forward another external URL from your web server to Prosody, 44 http_paths = {
45 use `pastebin_url` to set that URL. 45 pastebin = "/$host-paste";
46 }
47 ```
46 48
47 # Discovery 49 # Discovery
48 50
49 The line and character tresholds are advertised in 51 The line and character tresholds are advertised in
50 [service discovery][xep-0030] like this: 52 [service discovery][xep-0030] like this:
80 ------------------------- ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- 82 ------------------------- -------------------------------------------------------------------------------------------------------------------------------------------------------------------------
81 pastebin_threshold Maximum length (in characters) of a message that is allowed to skip the pastebin. (default 500 characters) 83 pastebin_threshold Maximum length (in characters) of a message that is allowed to skip the pastebin. (default 500 characters)
82 pastebin_line_threshold The maximum number of lines a message may have before it is sent to the pastebin. (default 4 lines) 84 pastebin_line_threshold The maximum number of lines a message may have before it is sent to the pastebin. (default 4 lines)
83 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) 85 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)
84 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. 86 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.
85 pastebin_ports List of ports to run the HTTP server on, same format as mod_httpserver's http_ports[^1]
86 pastebin_url Base URL to display for pastebin links, must end with / and redirect to Prosody's built-in HTTP server[^2]
87 87
88 # Compatibility 88 # Compatibility
89 89
90 ------ ------- 90 ------ ---------------------
91 trunk Works 91 trunk Works as of 25-06-13
92 13 Works
92 0.12 Works 93 0.12 Works
93 0.11 Works 94 ------ ---------------------
94 0.10 Works
95 0.9 Works
96 0.8 Works
97 ------ -------
98 95
99 # Todo 96 # Todo
100 97
101 - Maximum paste length 98 - Maximum paste length
102 - Web interface to submit pastes? 99 - Web interface to submit pastes?
103
104 [^1]: As of Prosody 0.9, `pastebin_ports` is replaced by `http_ports`,
105 see [Prosody HTTP server documentation](https://prosody.im/doc/http)
106
107 [^2]: See also
108 [http_external_url](https://prosody.im/doc/http#external_url)