# HG changeset patch
# User thijsalkemade@gmail.com
# Date 1370891827 0
# Node ID e935bb1e8299116051292433a7dc10d02e611063
# Parent  f2e6a9392edb341caca1ada189b27c1667a0f780
Created wiki page through web user interface.

diff -r f2e6a9392edb -r e935bb1e8299 mod_onions.wiki
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_onions.wiki	Mon Jun 10 19:17:07 2013 +0000
@@ -0,0 +1,32 @@
+#summary s2s to Tor hidden services
+#labels Stage-Alpha
+
+= Introduction =
+
+This plugin allows Prosody to connect to other servers that are running as a Tor hidden service. Running Prosody on a hidden service works without this module, this module is only necessary to allow Prosody to federate to hidden XMPP servers.
+
+For general info about creating a hidden service, see https://www.torproject.org/docs/tor-hidden-service.html.en.
+
+= Usage =
+This module depends on the bit32 Lua library.
+
+To create a hidden service that can federate with other hidden XMPP servers, first add a hidden serivce to Tor. It should listen on port 5269 and optionally also on 5222 (if c2s connections to the hidden service should be allowed).
+
+Use the hostname that Tor gives with a virtualhost:
+
+{{{
+VirtualHost "555abcdefhijklmn.onion"
+	modules_enabled = { "onions" };
+}}}
+
+= Configuration =
+|| *Name* || *Description* || *Type* || *Default value* ||
+|| onions_socks5_host || the host to connect to for Tor's SOCKS5 proxy || string || "127.0.0.1" ||
+|| onions_socks5_port || the port to connect to for Tor's SOCKS5 proxy || string || "9050" ||
+|| onions_only || forbid all connection attempts to non-onion servers || boolean || false ||
+
+
+
+= Compatibility =
+||0.8||Doesn't work||
+||0.9||Works||
\ No newline at end of file