Synapse Invite Policies

Synapse Invite Policies is a synapse module to restrict invites on a homeserver. Currently this only supports restricting all outgoing invites.

---

Table of Contents

• Installation
• Configuration
• Usage
• Testing
• License

Installation

TODO: requires publishing on pypi.

pip install synapse-invite-policies

Configuration

Here are the available configuration options:

# the outer modules section is just provided for completeness, the config block is the actual module config.
modules:
  - module: "synapse_invite_policies.InvitePolicies"
    config:
      # Block all invites sent by local users
      block_all_outgoing_invites: true

Testing

The tests uses twisted's testing framework trial, with the development enviroment managed by hatch. Running the tests and generating a coverage report can be done like this:

hatch run cov

License

synapse-invite-policies is distributed under the terms of the AGPL-3.0 license.