# HG changeset patch
# User MWild1
# Date 1253887668 0
# Node ID 310c9bbceb3d6cd16accbcc30821a12089df2402
# Parent  9e5bdacd9a42325cd15fb74f1d0085d1f2402343
Created wiki page through web user interface.

diff -r 9e5bdacd9a42 -r 310c9bbceb3d mod_pastebin.wiki
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_pastebin.wiki	Fri Sep 25 14:07:48 2009 +0000
@@ -0,0 +1,31 @@
+#summary Redirect long messages to built-in pastebin
+
+= 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" 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||
+
+= Todo =
+
+  * Configurable message length threshold
+  * Expire pastes
+  * Maximum paste length
+  * Web interface to submit pastes?
\ No newline at end of file