Update documentation in the wake of v2.4.1 (#85)

- Synapse-http-antispam do_ping and troubleshooting guide has been
  added.

- RoomTakedownProtection updated to no longer depend on
  synapse-http-antispam.

Author: Gnuxie

docs/bot/synapse-http-antispam.md

@@ -34,35 +34,52 @@ modules:
       # http://`<draupnir host>:<port>/api/1/spam_check`
       base_url: http://localhost:8080/api/1/spam_check
       authorization: YOUR_SECRET_TOKEN
+      do_ping: true
       enabled_callbacks:
-        - check_event_for_spam
         - user_may_invite
         - user_may_join_room
       fail_open:
-        check_event_for_spam: true
         user_may_invite: true
         user_may_join_room: true
-      async:
-        check_event_for_spam: true
 ```
 
-Currently we only support the `check_event_for_spam`, `user_may_invite`, and
-`user_may_join_room` callbacks. We strongly recommend that these endpoints are
-configured to `fail_open` so that your homeserver's service is not degraded
-should Draupnir fail or go offline.
-
-Additionally it is important that `check_event_for_spam` is configured to be
-`async`. This means that Synapse will not wait for a response from Draupnir.
-Draupnir only uses this check to source information about the matrix rooms your
-server is participating in.
-
-If your server has a very high maximum PDU rate (50PDU/s or above) you may wish
-to consider disabling the `check_event_for_spam` callback entirely. It is
-unlikely that your server will unless you are offering a service on the scale of
-matrix.org.
+Currently we only support the `user_may_invite`, and `user_may_join_room`
+callbacks. We strongly recommend that these endpoints are configured to
+`fail_open` so that your homeserver's service is not degraded should Draupnir
+fail or go offline.
 
 ### Draupnir Configuration
 
 You will also need to enable `synapseHTTPAntispam` under the `web` property in
 Draupnir's config (see
 [default.yaml](https://github.com/the-draupnir-project/Draupnir/blob/main/config/default.yaml)).
+
+## Troubleshooting or verifying connection from Synapse
+
+:::info
+
+Support for `do_ping` is available from Draupnir v2.4.0.
+
+:::
+
+In order to verify that Synapse, or any of its workers, are able to reach the
+draupnir antispam server, you can look for the following messages in Synapse
+logs.
+
+1. Verify that the Synapse module is loaded by searching for `Loaded module`.
+   You should find a line that looks like this:
+   `synapse.app._base - 584 - INFO - sentinel - Loaded module <synapse_http_antispam.HTTPAntispam object at 0x79613db08b00>`
+
+2. Verify that synapse-http-antispam is able to reach Draupnir by searching for
+   `Successfully pinged antispam server`. You should be able to see a line that
+   looks like this:
+   `synapse_http_antispam - 65 - INFO - sentinel - Successfully pinged antispam server with request ID UAhDvDkv`
+
+3. Verify that synapse-http-antispam is unable to reach Draupnir by searching
+   for `Failed to ping antispam server`. You should be able to see a line that
+   looks like this:
+   `synapse_http_antispam - 68 - ERROR - sentinel - Failed to ping antispam server (POST http://draupnir:localhost:8082/api/1/spam_check/ping)`
+
+4. Verify that Draupnir's configuration is correct by looking for the message
+   `There are unknown configuration properties` in Draupnir's log, and checking
+   if any properties are relevant.

docs/protections/room-takedown-protection.md

@@ -2,52 +2,57 @@
 
 :::info
 
-You need to be using Draupnir v2.3.0 or above to use this protection
+You need to be using Draupnir v2.3.0 or above to use this protection. Since
+Draupnir v2.4.1, this protection no longer depends upon synapse-http-antispam.
 
-You also need to follow the [instructions](../bot/synapse-http-antispam) for adding the synapse-http-antispam module.
+:::
+
+:::tip
+
+While this protection does not depend on synapse-http-antispam. You may wish to
+install the protection if you want to preemptively block invitations as soon as
+possible. You should follow our [instructions](../bot/synapse-http-antispam) for
+adding the synapse-http-antispam module.
 
 :::
 
-The room takedown protection matches policies from Draupnir's watched
-lists against the rooms your homeserver is joined to.
+The room takedown protection matches policies from Draupnir's watched lists
+against the rooms your homeserver is joined to.
 
-This protection is useful when you are administrating a server with
-open registration and need to protect yourself and your users from
-two scenarios:
+This protection is useful when you are administrating a server with open
+registration and need to protect yourself and your users from two scenarios:
 
-1. Spam invitations targetting your local users that have already been
-   sent and need to be rejected automatically.
+1. Spam invitations targetting your local users that have already been sent and
+   need to be rejected automatically.
 
-2. Preventing local users from joining rooms with intolerable or
-   illegal content, and removing these rooms if they are detected
-   on the homeserver.
+2. Preventing local users from joining rooms with intolerable or illegal
+   content, and removing these rooms if they are detected on the homeserver.
 
-If the protection discovers a room is marked with the `takedown`
-recommendation, then the protection will instruct your homeserver to
-shutdown the room. This will force all local participants to leave the
-room, purge the history from your database, and block the room.
+If the protection discovers a room is marked with the `takedown` recommendation,
+then the protection will instruct your homeserver to shutdown the room. This
+will force all local participants to leave the room, purge the history from your
+database, and block the room.
 
 ## Room Discovery
 
-The protection provides a means of oversight into the rooms your
-homeserver is participating within. When a room is discovered no your
-homeserver, a notification is sent to a configured room with details
-about the room: the title, description, creator, and member count.
+The protection provides a means of oversight into the rooms your homeserver is
+participating within. When a room is discovered no your homeserver, a
+notification is sent to a configured room with details about the room: the
+title, description, creator, and member count.
 
-The protection includes a threshold
-`discoveryNotificationMembershipThreshold` that must be met before
-displaying the notification. By default, a room needs to have `20`
-members before its details will be displayed. This is a privacy
-concious default to balance between alerting the server admins of all
-rooms, and those that are large enough to be of concern.
+The protection includes a threshold `discoveryNotificationMembershipThreshold`
+that must be met before displaying the notification. By default, a room needs to
+have `20` members before its details will be displayed. This is a privacy
+concious default to balance between alerting the server admins of all rooms, and
+those that are large enough to be of concern.
 
 ## Configuration
 
-See [configuring protections](./configuring-protections) for a guide
-on how to configure this protection.
+See [configuring protections](./configuring-protections) for a guide on how to
+configure this protection.
 
 ## Taking down a room
 
-To takedown a room yourself, you will need to use the `!draupnir
-takedown` command. You will be prompted for confirmation, and will be
-required to read the details very carefully.
+To takedown a room yourself, you will need to use the `!draupnir takedown`
+command. You will be prompted for confirmation, and will be required to read the
+details very carefully.