view mod_pastebin.wiki @ 116:026e0e86dd96

Fixed the wiki markup for the todo list, added some links and a new todo
author MWild1
date Mon, 01 Feb 2010 17:49:11 +0000
parents 7996062e839e
children 927270e0b963
line wrap: on
line source

#summary Redirect long messages to built-in pastebin
#labels Stage-Beta

= Introduction =

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.

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!

= Details =

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.

= Usage =

Load mod_pastebin onto the MUC component (interestingly it can also be loaded on normal hosts and it will intercept standard chat messages).

For example:
{{{
Component "conference.example.com" "muc"
    modules_enabled = { "pastebin" }
}}}

= Configuration =
||pastebin_ports||List of ports to run the HTTP server on, same format as mod_httpserver's http_ports||
||pastebin_threshold||Minimum length (in characters) of a message to be sent to the pastebin (default 500 characters)||
||pastebin_url||Base URL to display for pastebin links, must end with / and redirect to Prosody's built-in HTTP server||
||pastebin_expire_after||Number of hours after which to expire (remove) a paste, defaults to 24||

= Compatibility =
||0.6||Works||
||0.5||Works||

= Todo =

  * Maximum paste length
  * Web interface to submit pastes?