# HG changeset patch
# User Marco Cirillo <maranda@lightwitch.org>
# Date 1323013767 0
# Node ID 8b15faa008e3d7c4e81cf34165c7b0317ee8bdf9
# Parent  8b5492ea07d91e58f7ef4b884de6768ab9a36d36
added wiki.

diff -r 8b5492ea07d9 -r 8b15faa008e3 mod_host_guard.wiki
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_host_guard.wiki	Sun Dec 04 15:49:27 2011 +0000
@@ -0,0 +1,26 @@
+#summary Granular remote host blacklisting plugin
+#labels Stage-Stable
+
+= Details =
+
+As often it's undesiderable to employ whitelisting logics in public environments, this module let's you more selectively
+restrict access to your hosts (component or server host) either disallowing access completely or blacklisting certain sources.
+
+= Usage =
+
+Copy the plugin into your prosody's modules directory.
+And add it between your enabled modules into the global section (modules_enabled):
+
+ * The plugin can work either by blocking all remote access (s2s) to a certain resource (useful for components)
+ * Or by selectively blocking certain remote hosts through blacklisting (by using host_guard_selective and host_guard_blacklisting)
+
+Syntax:
+{{{
+host_guard_blockall = { "no_access.yourhost.com", "no_access2.yourhost.com" }
+host_guard_selective = { "no_access_from_blsted.myhost.com", "no_access_from_blsted.mycomponent.com" }
+host_guard_blacklist = { "remoterogueserver.com", "remoterogueserver2.com" }
+}}}
+
+= Compatibility =
+
+ * Works with 0.8.x, successive versions and trunk.