prosody-modules
24316a399978
mod_admin_blocklist/README.md

Find changesets by keywords by author, files, the commit message, revision number or hash, or revset expression.

Software / code / prosody-modules

Annotate

mod_admin_blocklist/README.md @ 6210:24316a399978 draft

Merge
author Trần H. Trung <xmpp:trần.h.trung@trung.fun>
date Tue, 18 Mar 2025 00:19:25 +0700
parent 6209:d611ed13df7e
child 6211:750d64c47ec6
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6209
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
1 ---
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
2 summary: Block s2s connections based on admin blocklist
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
3 labels:
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
4 - 'Stage-Beta'
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
5 ...
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
6
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
7 This module uses the blocklists set by admins for blocking s2s
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
8 connections.
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
9
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
10 So if an admin blocks a bare domain using [Blocking Command][xep191]
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
11 via [mod\_blocklist][doc:modules:mod_blocklist] then no s2s connections
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
12 will be allowed to or from that domain.
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
13
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
14 # Configuring
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
15
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
16 The role or roles that determine whether a
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
17 particular users blocklist is used can be configured:
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
18
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
19 ```lua
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
20 -- This is the default:
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
21 admin_blocklist_roles = { "prosody:operator", "prosody:admin" }
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
22 ```
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
23
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
24 # Compatibility
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
25
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
26 Prosody-Version Status
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
27 --------------- ------
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
28 trunk* Works
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
29 0.12 Works
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
30
Trần H. Trung <xmpp:trần.h.trung@trung.fun>
parents:
diff changeset
31 *as of 2024-12-21