prosody-modules
fb2ba31a4e26
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 @ 6062:fb2ba31a4e26

mod_report_affiliations: Remove irrelevant note from README
author Matthew Wild <mwild1@gmail.com>
date Mon, 25 Nov 2024 12:39:41 +0000
parent 6004:bd0b4d8aa94e
child 6103:0e0c6618e154
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
1855
7eef1a3a2a17 mod_admin_blocklist: Add README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
1 ---
7eef1a3a2a17 mod_admin_blocklist: Add README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
2 summary: Block s2s connections based on admin blocklists
6004
bd0b4d8aa94e mod_admin_blocklist: Update README Compability Section
Menel <menel@snikket.de>
parents: 6003
diff changeset
3 labels:
bd0b4d8aa94e mod_admin_blocklist: Update README Compability Section
Menel <menel@snikket.de>
parents: 6003
diff changeset
4 - 'Stage-Beta'
1855
7eef1a3a2a17 mod_admin_blocklist: Add README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
5 ...
7eef1a3a2a17 mod_admin_blocklist: Add README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
6
7eef1a3a2a17 mod_admin_blocklist: Add README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
7 This module uses the blocklists set by admins for blocking s2s
7eef1a3a2a17 mod_admin_blocklist: Add README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
8 connections.
7eef1a3a2a17 mod_admin_blocklist: Add README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
9
2315
212564152060 mod_admin_blocklist/README: Autolinks!
Kim Alvefur <zash@zash.se>
parents: 2314
diff changeset
10 So if an admin blocks a bare domain using [Blocking Command][xep191]
2316
2a2de19413e7 mod_admin_blocklist/README: Turns out autolink.lua doesn't know about official modules
Kim Alvefur <zash@zash.se>
parents: 2315
diff changeset
11 via [mod\_blocklist][doc:modules:mod_blocklist] then no s2s connections
2a2de19413e7 mod_admin_blocklist/README: Turns out autolink.lua doesn't know about official modules
Kim Alvefur <zash@zash.se>
parents: 2315
diff changeset
12 will be allowed to or from that domain.
5017
96e83b4a93f7 mod_admin_blocklist: Add config option for which role(s) to consider (0.12+)
Kim Alvefur <zash@zash.se>
parents: 2316
diff changeset
13
96e83b4a93f7 mod_admin_blocklist: Add config option for which role(s) to consider (0.12+)
Kim Alvefur <zash@zash.se>
parents: 2316
diff changeset
14 # Configuring
96e83b4a93f7 mod_admin_blocklist: Add config option for which role(s) to consider (0.12+)
Kim Alvefur <zash@zash.se>
parents: 2316
diff changeset
15
6004
bd0b4d8aa94e mod_admin_blocklist: Update README Compability Section
Menel <menel@snikket.de>
parents: 6003
diff changeset
16 The role or roles that determine whether a
5017
96e83b4a93f7 mod_admin_blocklist: Add config option for which role(s) to consider (0.12+)
Kim Alvefur <zash@zash.se>
parents: 2316
diff changeset
17 particular users blocklist is used can be configured:
96e83b4a93f7 mod_admin_blocklist: Add config option for which role(s) to consider (0.12+)
Kim Alvefur <zash@zash.se>
parents: 2316
diff changeset
18
96e83b4a93f7 mod_admin_blocklist: Add config option for which role(s) to consider (0.12+)
Kim Alvefur <zash@zash.se>
parents: 2316
diff changeset
19 ```lua
96e83b4a93f7 mod_admin_blocklist: Add config option for which role(s) to consider (0.12+)
Kim Alvefur <zash@zash.se>
parents: 2316
diff changeset
20 -- This is the default:
96e83b4a93f7 mod_admin_blocklist: Add config option for which role(s) to consider (0.12+)
Kim Alvefur <zash@zash.se>
parents: 2316
diff changeset
21 admin_blocklist_roles = { "prosody:operator", "prosody:admin" }
96e83b4a93f7 mod_admin_blocklist: Add config option for which role(s) to consider (0.12+)
Kim Alvefur <zash@zash.se>
parents: 2316
diff changeset
22 ```
96e83b4a93f7 mod_admin_blocklist: Add config option for which role(s) to consider (0.12+)
Kim Alvefur <zash@zash.se>
parents: 2316
diff changeset
23
6004
bd0b4d8aa94e mod_admin_blocklist: Update README Compability Section
Menel <menel@snikket.de>
parents: 6003
diff changeset
24 #Compatibility
5017
96e83b4a93f7 mod_admin_blocklist: Add config option for which role(s) to consider (0.12+)
Kim Alvefur <zash@zash.se>
parents: 2316
diff changeset
25
6004
bd0b4d8aa94e mod_admin_blocklist: Update README Compability Section
Menel <menel@snikket.de>
parents: 6003
diff changeset
26 ------- -------
bd0b4d8aa94e mod_admin_blocklist: Update README Compability Section
Menel <menel@snikket.de>
parents: 6003
diff changeset
27 trunk* Works
bd0b4d8aa94e mod_admin_blocklist: Update README Compability Section
Menel <menel@snikket.de>
parents: 6003
diff changeset
28 0.12 Works
bd0b4d8aa94e mod_admin_blocklist: Update README Compability Section
Menel <menel@snikket.de>
parents: 6003
diff changeset
29 ------- -------
bd0b4d8aa94e mod_admin_blocklist: Update README Compability Section
Menel <menel@snikket.de>
parents: 6003
diff changeset
30
bd0b4d8aa94e mod_admin_blocklist: Update README Compability Section
Menel <menel@snikket.de>
parents: 6003
diff changeset
31 *as of 2024-10-22