Mercurial > prosody-wiki
annotate mod_pastebin.wiki @ 401:f7bca760e9b5
mod_watchuntrusted: Created a wiki page describing this module
| author | thijsalkemade@gmail.com |
|---|---|
| date | Wed, 11 Sep 2013 23:32:56 +0000 |
| parents | d4d1035c8700 |
| children | 25afe4b60780 |
| rev | line source |
|---|---|
| 8 | 1 #summary Redirect long messages to built-in pastebin |
| 136 | 2 #labels Stage-Stable |
| 8 | 3 |
| 4 = Introduction = | |
| 5 | |
| 6 Pastebins are used very often in IM, especially in chat rooms. You have a long log or command output which you need to send to someone over IM, and don't want to fill their message window with it. Put it on a pastebin site, and give them the URL instead, simple. | |
| 7 | |
| 8 Not for everyone... no matter how hard you try, people will be unaware, or not care. They may also be too lazy to visit a pastebin. This is where mod_pastebin comes in! | |
| 9 | |
| 10 = Details = | |
| 11 | |
|
272
d4d1035c8700
Added note about default URL (thanks Nulani)
MWild1@gmail.com
parents:
246
diff
changeset
|
12 When someone posts to a room a "large" (the actual limit is configurable) message, Prosody will intercept the message and convert it to a URL pointing to a built-in pastebin server. The URLs are randomly generated, so they can be considered for most purposes to be private, and cannot be discovered by people who are not in the room. |
| 8 | 13 |
| 14 = Usage = | |
| 15 | |
|
138
d88da0ded786
Clarify that mod_pastebin must be loaded especially for components
MWild1
parents:
136
diff
changeset
|
16 To set up mod_pastebin for MUC rooms it *must* be explicitly loaded, as in the example below - it won't work when loaded globally, as that will only load it onto normal virtual hosts. |
| 8 | 17 |
| 18 For example: | |
| 19 {{{ | |
| 20 Component "conference.example.com" "muc" | |
| 21 modules_enabled = { "pastebin" } | |
| 22 }}} | |
| 23 | |
|
272
d4d1035c8700
Added note about default URL (thanks Nulani)
MWild1@gmail.com
parents:
246
diff
changeset
|
24 Pastes will be available by default at `http://<your-prosody>:5280/pastebin/` by default. 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. |
|
d4d1035c8700
Added note about default URL (thanks Nulani)
MWild1@gmail.com
parents:
246
diff
changeset
|
25 |
| 8 | 26 = Configuration = |
| 27 ||pastebin_ports||List of ports to run the HTTP server on, same format as mod_httpserver's http_ports|| | |
| 136 | 28 ||pastebin_threshold||Maximum length (in characters) of a message that is allowed to skip the pastebin. (default 500 characters)|| |
| 29 ||pastebin_line_threshold||The maximum number of lines a message may have before it is sent to the pastebin. (default 4 lines)|| | |
| 30 ||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)|| | |
| 40 | 31 ||pastebin_url||Base URL to display for pastebin links, must end with / and redirect to Prosody's built-in HTTP server|| |
|
246
000cd449e801
Add compatibility status for 0.8 and note about persistent pastes.
MWild1@gmail.com
parents:
138
diff
changeset
|
32 ||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.|| |
| 8 | 33 |
| 20 | 34 = Compatibility = |
|
246
000cd449e801
Add compatibility status for 0.8 and note about persistent pastes.
MWild1@gmail.com
parents:
138
diff
changeset
|
35 ||0.8||Works|| |
| 136 | 36 ||0.7||Works|| |
| 20 | 37 ||0.6||Works|| |
| 38 | |
| 8 | 39 = Todo = |
| 40 | |
| 41 * Maximum paste length | |
| 42 * Web interface to submit pastes? |