AuditBot

AuditBot is a bot user that is invited into every room, and will write raw events to configured outputs. AuditBot is able to force itself back as a user admin in case he is kicked out of a room. It can be configured to audit rooms and optionally private messages.

You will need to configure AuditBot Outputs to get audited rooms events in an external service.

Example configuration

AuditBot is preconfigured by ESS to login to the local homeserver. You can configured the following options:

base:
  config:
    options:
      # (Optional) Should the bot join or leave DMs?
      shouldJoinDMs: false

      # (Optional) Only join rooms which are under the homeserver's domain.
      onlyJoinLocalRooms: false

      # (Optional) Skip a room if its creator matches this regex.
      skipRoomsMatchingCreator: /bad-creator/

      # (Optional) Only handle rooms that are this active.
      minimumLastActiveMinutes: 50

      # (Optional) Always ignore these room IDs.
      denyRooms:
        - "!never-join-this-room:example.org"

      # (Optional) Only join these room IDs.
      onlyRooms:
        - "!only-join-this-room:example.org"