Mercurial > prosody-modules

annotate mod_admin_blocklist/README.markdown @ 5389:d872a1cd8c1d

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
mod_http_oauth2: Specify that 'contacts' items are emails in client registration Not enforced, but good for documentation. > Array of strings representing ways to contact people responsible for > this client, typically email addresses. "typically" isn't a great word in a specification, so one could persume this may be e.g. URLs like https://example.com/contact-us or so as well.
author Kim Alvefur <zash@zash.se>
date Sun, 30 Apr 2023 15:20:05 +0200
parents 96e83b4a93f7
children
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
7eef1a3a2a17 mod_admin_blocklist: Add README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
3 ...
7eef1a3a2a17 mod_admin_blocklist: Add README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
4
7eef1a3a2a17 mod_admin_blocklist: Add README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
5 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
6 connections.
7eef1a3a2a17 mod_admin_blocklist: Add README
Kim Alvefur <zash@zash.se>
parents:
diff changeset
7
2315
212564152060 mod_admin_blocklist/README: Autolinks!
Kim Alvefur <zash@zash.se>
parents: 2314
diff changeset
8 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
9 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
10 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
11
96e83b4a93f7 mod_admin_blocklist: Add config option for which role(s) to consider (0.12+)
Kim Alvefur <zash@zash.se>
parents: 2316
diff changeset
12 # 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
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 ## Prosody 0.12
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
96e83b4a93f7 mod_admin_blocklist: Add config option for which role(s) to consider (0.12+)
Kim Alvefur <zash@zash.se>
parents: 2316
diff changeset
16 Starting with Prosody 0.12, the role or roles that determine whether a
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
96e83b4a93f7 mod_admin_blocklist: Add config option for which role(s) to consider (0.12+)
Kim Alvefur <zash@zash.se>
parents: 2316
diff changeset
24 ## Prosody 0.11
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
96e83b4a93f7 mod_admin_blocklist: Add config option for which role(s) to consider (0.12+)
Kim Alvefur <zash@zash.se>
parents: 2316
diff changeset
26 In Prosody 0.11 the [`admins`][doc:admins] setting is used.