prosody-modules
7bb2f149f8ec
mod_pastebin/README.markdown

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.markdown @ 1834:7bb2f149f8ec

mod_pastebin/README: Try to clarify the config differences in 0.9+
author Kim Alvefur <zash@zash.se>
date Wed, 09 Sep 2015 14:22:37 +0200
parent 1803:4d73a1a6ba68
child 3484:ce89fabb1f02
comparison
equal deleted inserted replaced
1833:52e998bb4490 1834:7bb2f149f8ec
36 36
37 Component "conference.example.com" "muc" 37 Component "conference.example.com" "muc"
38 modules_enabled = { "pastebin" } 38 modules_enabled = { "pastebin" }
39 39
40 Pastes will be available by default at 40 Pastes will be available by default at
41 `http://<your-prosody>:5280/pastebin/` by default. This can be changed 41 `http://<your-prosody>:5280/pastebin/` by default.
42 with `pastebin_ports` (see below), or you can forward another external 42
43 URL from your web server to Prosody, use `pastebin_url` to set that URL. 43 In Prosody 0.9 and later this can be changed with [HTTP
44 settings](https://prosody.im/doc/http).
45
46 In 0.8 and older this can be changed with `pastebin_ports` (see below),
47 or you can forward another external URL from your web server to Prosody,
48 use `pastebin_url` to set that URL.
44 49
45 Configuration 50 Configuration
46 ============= 51 =============
47 52
53 Option Description
48 --------------------------- ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- 54 --------------------------- -------------------------------------------------------------------------------------------------------------------------------------------------------------------------
49 pastebin\_ports List of ports to run the HTTP server on, same format as mod\_httpserver's http\_ports
50 pastebin\_threshold Maximum length (in characters) of a message that is allowed to skip the pastebin. (default 500 characters) 55 pastebin\_threshold Maximum length (in characters) of a message that is allowed to skip the pastebin. (default 500 characters)
51 pastebin\_line\_threshold The maximum number of lines a message may have before it is sent to the pastebin. (default 4 lines) 56 pastebin\_line\_threshold The maximum number of lines a message may have before it is sent to the pastebin. (default 4 lines)
52 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) 57 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)
53 pastebin\_url Base URL to display for pastebin links, must end with / and redirect to Prosody's built-in HTTP server
54 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. 58 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.
55 --------------------------- ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- 59 pastebin\_ports List of ports to run the HTTP server on, same format as mod\_httpserver's http\_ports[^1]
60 pastebin\_url Base URL to display for pastebin links, must end with / and redirect to Prosody's built-in HTTP server[^2]
56 61
57 Compatibility 62 Compatibility
58 ============= 63 =============
59 64
60 ----- -------------------------------------------------------------------------------- 65 ----- -------
61 0.9 Works, but pastebin\_ports does not exist anymore, see the 0.9.0 release notes 66 0.9 Works
62 0.8 Works 67 0.8 Works
63 0.7 Works 68 0.7 Works
64 0.6 Works 69 0.6 Works
65 ----- -------------------------------------------------------------------------------- 70 ----- -------
66 71
67 Todo 72 Todo
68 ==== 73 ====
69 74
70 - Maximum paste length 75 - Maximum paste length
71 - Web interface to submit pastes? 76 - Web interface to submit pastes?
77
78 [^1]: As of Prosody 0.9, `pastebin_ports` is replaced by `http_ports`,
79 see [Prosody HTTP server documentation](https://prosody.im/doc/http)
80
81 [^2]: See also
82 [http\_external\_url](https://prosody.im/doc/http#external_url)