Diff

mod_admin_blocklist/README.md @ 6003:fe081789f7b5

All community modules: Unify file extention of Markdown files to .md
author Menel <menel@snikket.de>
date Tue, 22 Oct 2024 10:26:01 +0200
parent 5017:96e83b4a93f7
child 6004:bd0b4d8aa94e
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/mod_admin_blocklist/README.md	Tue Oct 22 10:26:01 2024 +0200
@@ -0,0 +1,26 @@
+---
+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][xep191]
+via [mod\_blocklist][doc:modules:mod_blocklist] then no s2s connections
+will be allowed to or from that domain.
+
+# Configuring
+
+## Prosody 0.12
+
+Starting with Prosody 0.12, the role or roles that determine whether a
+particular users blocklist is used can be configured:
+
+```lua
+-- This is the default:
+admin_blocklist_roles = { "prosody:operator", "prosody:admin" }
+```
+
+## Prosody 0.11
+
+In Prosody 0.11 the [`admins`][doc:admins] setting is used.