|
1 --- |
|
2 labels: |
|
3 - 'Stage-Stable' |
|
4 summary: 'Redirect long messages to built-in pastebin' |
|
5 ... |
|
6 |
|
7 Introduction |
|
8 ============ |
|
9 |
|
10 Pastebins are used very often in IM, especially in chat rooms. You have |
|
11 a long log or command output which you need to send to someone over IM, |
|
12 and don't want to fill their message window with it. Put it on a |
|
13 pastebin site, and give them the URL instead, simple. |
|
14 |
|
15 Not for everyone... no matter how hard you try, people will be unaware, |
|
16 or not care. They may also be too lazy to visit a pastebin. This is |
|
17 where mod\_pastebin comes in! |
|
18 |
|
19 Details |
|
20 ======= |
|
21 |
|
22 When someone posts to a room a "large" (the actual limit is |
|
23 configurable) message, Prosody will intercept the message and convert it |
|
24 to a URL pointing to a built-in pastebin server. The URLs are randomly |
|
25 generated, so they can be considered for most purposes to be private, |
|
26 and cannot be discovered by people who are not in the room. |
|
27 |
|
28 Usage |
|
29 ===== |
|
30 |
|
31 To set up mod\_pastebin for MUC rooms it **must** be explicitly loaded, |
|
32 as in the example below - it won't work when loaded globally, as that |
|
33 will only load it onto normal virtual hosts. |
|
34 |
|
35 For example: |
|
36 |
|
37 Component "conference.example.com" "muc" |
|
38 modules_enabled = { "pastebin" } |
|
39 |
|
40 Pastes will be available by default at |
|
41 `http://<your-prosody>:5280/pastebin/` by default. This can be changed |
|
42 with `pastebin_ports` (see below), or you can forward another external |
|
43 URL from your web server to Prosody, use `pastebin_url` to set that URL. |
|
44 |
|
45 Configuration |
|
46 ============= |
|
47 |
|
48 --------------------------- ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
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) |
|
51 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) |
|
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. |
|
55 --------------------------- ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
|
56 |
|
57 Compatibility |
|
58 ============= |
|
59 |
|
60 ----- -------------------------------------------------------------------------------- |
|
61 0.9 Works, but pastebin\_ports does not exist anymore, see the 0.9.0 release notes |
|
62 0.8 Works |
|
63 0.7 Works |
|
64 0.6 Works |
|
65 ----- -------------------------------------------------------------------------------- |
|
66 |
|
67 Todo |
|
68 ==== |
|
69 |
|
70 - Maximum paste length |
|
71 - Web interface to submit pastes? |