view mod_admin_blocklist/README.markdown @ 5907:d194d1012fd3

Updating dox for mod_rest. Ideas expressed / clarified: 1) Making clear that mod_rest isn't to be installed under VirtualHosts AND as a component. 2) Understanding some of the implications of this choice: A) Changes to user authentication B) How it affects subdomains 3) More consistent use of domain names for clarity. 4) Using different heading sizes to show scope of section. Essentially, I added all the tidbits I had to clarify in getting this to work in my own example.
author Ben Smith <bens@effortlessis.com>
date Mon, 13 May 2024 13:25:13 -0700
parents 96e83b4a93f7
children
line wrap: on
line source

---
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.