view @ 308:f5d82d6588d4

mod_auth_external: Clarify the protocol a bit more.
author Waqas Hussain <>
date Wed, 10 Oct 2012 01:28:20 +0500
parents 9afa02b561fa
children 85a5bc45b8b9
line wrap: on
line source

#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 = { "", "", "" }

For blacklist, 

s2s_blacklist = { "", "" }

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 ||