annotate mod_pastebin.wiki @ 495:fa33da93a246

trim trailing whitespace
author Kim Alvefur <zash@zash.se>
date Tue, 18 Nov 2014 14:06:49 +0100
parents 25afe4b60780
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
8
310c9bbceb3d Created wiki page through web user interface.
MWild1
parents:
diff changeset
1 #summary Redirect long messages to built-in pastebin
136
927270e0b963 Updated config options and compatibility section.
MWild1
parents: 43
diff changeset
2 #labels Stage-Stable
8
310c9bbceb3d Created wiki page through web user interface.
MWild1
parents:
diff changeset
3
310c9bbceb3d Created wiki page through web user interface.
MWild1
parents:
diff changeset
4 = Introduction =
310c9bbceb3d Created wiki page through web user interface.
MWild1
parents:
diff changeset
5
310c9bbceb3d Created wiki page through web user interface.
MWild1
parents:
diff changeset
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.
310c9bbceb3d Created wiki page through web user interface.
MWild1
parents:
diff changeset
7
310c9bbceb3d Created wiki page through web user interface.
MWild1
parents:
diff changeset
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!
310c9bbceb3d Created wiki page through web user interface.
MWild1
parents:
diff changeset
9
310c9bbceb3d Created wiki page through web user interface.
MWild1
parents:
diff changeset
10 = Details =
310c9bbceb3d Created wiki page through web user interface.
MWild1
parents:
diff changeset
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
310c9bbceb3d Created wiki page through web user interface.
MWild1
parents:
diff changeset
13
310c9bbceb3d Created wiki page through web user interface.
MWild1
parents:
diff changeset
14 = Usage =
310c9bbceb3d Created wiki page through web user interface.
MWild1
parents:
diff changeset
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
310c9bbceb3d Created wiki page through web user interface.
MWild1
parents:
diff changeset
17
310c9bbceb3d Created wiki page through web user interface.
MWild1
parents:
diff changeset
18 For example:
310c9bbceb3d Created wiki page through web user interface.
MWild1
parents:
diff changeset
19 {{{
310c9bbceb3d Created wiki page through web user interface.
MWild1
parents:
diff changeset
20 Component "conference.example.com" "muc"
310c9bbceb3d Created wiki page through web user interface.
MWild1
parents:
diff changeset
21 modules_enabled = { "pastebin" }
310c9bbceb3d Created wiki page through web user interface.
MWild1
parents:
diff changeset
22 }}}
310c9bbceb3d Created wiki page through web user interface.
MWild1
parents:
diff changeset
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
310c9bbceb3d Created wiki page through web user interface.
MWild1
parents:
diff changeset
26 = Configuration =
310c9bbceb3d Created wiki page through web user interface.
MWild1
parents:
diff changeset
27 ||pastebin_ports||List of ports to run the HTTP server on, same format as mod_httpserver's http_ports||
136
927270e0b963 Updated config options and compatibility section.
MWild1
parents: 43
diff changeset
28 ||pastebin_threshold||Maximum length (in characters) of a message that is allowed to skip the pastebin. (default 500 characters)||
927270e0b963 Updated config options and compatibility section.
MWild1
parents: 43
diff changeset
29 ||pastebin_line_threshold||The maximum number of lines a message may have before it is sent to the pastebin. (default 4 lines)||
927270e0b963 Updated config options and compatibility section.
MWild1
parents: 43
diff changeset
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
a82fbbe28ae0 Added description of pastebin_url config option
MWild1
parents: 27
diff changeset
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
310c9bbceb3d Created wiki page through web user interface.
MWild1
parents:
diff changeset
33
20
44fe50bac580 Added compatibility section
MWild1
parents: 19
diff changeset
34 = Compatibility =
466
25afe4b60780 mod_pastebin works on 0.9 but there's no pastebin_ports anymore
Kim Alvefur <zash@zash.se>
parents: 272
diff changeset
35 ||0.9||Works, but pastebin_ports does not exist anymore, see the 0.9.0 release notes||
246
000cd449e801 Add compatibility status for 0.8 and note about persistent pastes.
MWild1@gmail.com
parents: 138
diff changeset
36 ||0.8||Works||
136
927270e0b963 Updated config options and compatibility section.
MWild1
parents: 43
diff changeset
37 ||0.7||Works||
20
44fe50bac580 Added compatibility section
MWild1
parents: 19
diff changeset
38 ||0.6||Works||
44fe50bac580 Added compatibility section
MWild1
parents: 19
diff changeset
39
8
310c9bbceb3d Created wiki page through web user interface.
MWild1
parents:
diff changeset
40 = Todo =
310c9bbceb3d Created wiki page through web user interface.
MWild1
parents:
diff changeset
41
310c9bbceb3d Created wiki page through web user interface.
MWild1
parents:
diff changeset
42 * Maximum paste length
466
25afe4b60780 mod_pastebin works on 0.9 but there's no pastebin_ports anymore
Kim Alvefur <zash@zash.se>
parents: 272
diff changeset
43 * Web interface to submit pastes?