Browse Source

Documentation for Draupnir synapse-http-antispam integration

pull/4284/head
Catalan Lover 10 months ago
parent
commit
de6cb57f3f
No known key found for this signature in database GPG Key ID: 99A263BABA26C9D9
1 changed files with 14 additions and 0 deletions
  1. +14
    -0
      docs/configuring-playbook-bot-draupnir.md

+ 14
- 0
docs/configuring-playbook-bot-draupnir.md View File

@@ -145,6 +145,20 @@ The bot can intercept the report API endpoint of the client-server API, which re
matrix_bot_draupnir_config_web_abuseReporting: true matrix_bot_draupnir_config_web_abuseReporting: true
``` ```


### Enabling synapse-http-antispam support

Certain protections in Draupnir require the [synapse-http-antispam](https://github.com/maunium/synapse-http-antispam) module and a Synapse homeserver plus homeserver admin status to function. This module can be enabled in the playbook via setting `matrix_bot_draupnir_config_web_synapseHTTPAntispam_enabled` to `true` and making sure that Draupnir admin API access is enabled.

```yaml
# Enables the integration between Draupnir and synapse-http-antispam module.
matrix_bot_draupnir_config_web_synapseHTTPAntispam_enabled: true

# Enables draupnir to access Synapse admin APIs. This is required for the module functionality to take full effect.
matrix_bot_draupnir_admin_api_enabled: true
```

These protections need to be manually activated and consulting the [enabling protections](#enabling-built-in-protections) guide can be helpful or consulting upstream documentation.

<!-- <!--
NOTE: this is unsupported by the playbook due to the admin API being inaccessible from containers currently. NOTE: this is unsupported by the playbook due to the admin API being inaccessible from containers currently.




Loading…
Cancel
Save