annotate mod_pastebin.wiki @ 112:058ede538839

Clarified documentation, config and dependency on something else for viewing the logs.
author MWild1
date Mon, 01 Feb 2010 17:28:54 +0000
parents 7996062e839e
children 927270e0b963
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
27
0986c59fce05 Add Stage-Beta
MWild1
parents: 20
diff changeset
2 #labels Stage-Beta
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
19
936f87fe73e6 Updated todo and instructions for new pastebin_threshold option
MWild1
parents: 8
diff changeset
12 When someone posts to a room a "large" (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
310c9bbceb3d Created wiki page through web user interface.
MWild1
parents:
diff changeset
16 Load mod_pastebin onto the MUC component (interestingly it can also be loaded on normal hosts and it will intercept standard chat messages).
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
310c9bbceb3d Created wiki page through web user interface.
MWild1
parents:
diff changeset
24 = Configuration =
310c9bbceb3d Created wiki page through web user interface.
MWild1
parents:
diff changeset
25 ||pastebin_ports||List of ports to run the HTTP server on, same format as mod_httpserver's http_ports||
19
936f87fe73e6 Updated todo and instructions for new pastebin_threshold option
MWild1
parents: 8
diff changeset
26 ||pastebin_threshold||Minimum length (in characters) of a message to be sent to the pastebin (default 500 characters)||
40
a82fbbe28ae0 Added description of pastebin_url config option
MWild1
parents: 27
diff changeset
27 ||pastebin_url||Base URL to display for pastebin links, must end with / and redirect to Prosody's built-in HTTP server||
43
7996062e839e Added info about pastebin_expire_after and updated the todo
MWild1
parents: 40
diff changeset
28 ||pastebin_expire_after||Number of hours after which to expire (remove) a paste, defaults to 24||
8
310c9bbceb3d Created wiki page through web user interface.
MWild1
parents:
diff changeset
29
20
44fe50bac580 Added compatibility section
MWild1
parents: 19
diff changeset
30 = Compatibility =
44fe50bac580 Added compatibility section
MWild1
parents: 19
diff changeset
31 ||0.6||Works||
44fe50bac580 Added compatibility section
MWild1
parents: 19
diff changeset
32 ||0.5||Works||
44fe50bac580 Added compatibility section
MWild1
parents: 19
diff changeset
33
8
310c9bbceb3d Created wiki page through web user interface.
MWild1
parents:
diff changeset
34 = Todo =
310c9bbceb3d Created wiki page through web user interface.
MWild1
parents:
diff changeset
35
310c9bbceb3d Created wiki page through web user interface.
MWild1
parents:
diff changeset
36 * Maximum paste length
310c9bbceb3d Created wiki page through web user interface.
MWild1
parents:
diff changeset
37 * Web interface to submit pastes?