# HG changeset patch
# User gauravsri@gmail.com
# Date 1279300374 0
# Node ID 9afa02b561fa6bff07794da7b733f9930588bf02
# Parent  e38bd149d0c7764f109948de5bc51b076de540c5
Created wiki page through web user interface.

diff -r e38bd149d0c7 -r 9afa02b561fa mod_s2s_blackwhitelist.wiki
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_s2s_blackwhitelist.wiki	Fri Jul 16 17:12:54 2010 +0000
@@ -0,0 +1,42 @@
+#summary Module for setting blacklist and whitelist on new server to server connections
+
+= Introduction =
+
+This module adds the functionality of blacklist and whitelist for new server to server connections (federation). 
+
+
+= Details =
+
+If the configuration is changed then you can use console to issue "config:reload()" and this plugin will automatically reload the black/whitelists.
+
+You can either choose whitelist or blacklist functionality (both can't co-exist).
+
+Note: If a host with existing connections is blacklisted then this module will not tear down existing connection since that was created when the connection agreement was valid. You will need to use "s2s:close" command on console to manually close those connections.
+
+= Configuration =
+
+First define whether you need blacklist or whitelist,
+
+{{{
+s2s_enable_blackwhitelist = "whitelist" -- enable whitelist. use blacklist to use blacklists
+}}}
+
+Now create populate an array of domains in those lists
+
+For whitelist,
+
+{{{
+s2s_whitelist = { "abc.net", "gmail.com", "xyz.net" }
+}}}
+
+For blacklist, 
+
+{{{
+s2s_blacklist = { "gmail.com", "xyz.com" }
+}}}
+
+You can change configuration at runtime but need to use console plugin to reload configuration via "config:reload" command.
+
+= Compatibility =
+
+|| 0.7 || tested to work with dialbacks ||
\ No newline at end of file