diff mod_admin_blocklist/README.markdown @ 1855:7eef1a3a2a17

mod_admin_blocklist: Add README
author Kim Alvefur <zash@zash.se>
date Mon, 14 Sep 2015 13:11:26 +0200
parents
children e121273bdef2
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_admin_blocklist/README.markdown	Mon Sep 14 13:11:26 2015 +0200
@@ -0,0 +1,14 @@
+---
+summary: Block s2s connections based on admin blocklists
+...
+
+This module uses the blocklists set by admins for blocking s2s
+connections.
+
+So if an admin blocks a bare domain using [Blocking
+Command](http://xmpp.org/extensions/xep-0191.html) via
+[mod\_blocklist](https://prosody.im/doc/modules/mod_blocklist) then no
+s2s connections will be allowed to or from that domain.
+
+Note that the module may need to be reloaded after a blocklist has been
+updated.