diff mod_host_guard.wiki @ 240:8b15faa008e3

added wiki.
author Marco Cirillo <maranda@lightwitch.org>
date Sun, 04 Dec 2011 15:49:27 +0000
parents
children 012884e6ba5d
line wrap: on
line diff
--- /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.