Skip to content

Add Docker instructions for bind mounting the synapse module #548

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Add Docker instructions for bind mounting the synapse module #548

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 12 additions & 1 deletion docs/synapse_module.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,4 +61,15 @@ already be participating in the ban lists - if it is not, you will need to have
on your homeserver join. The antispam module will not join the rooms for you.

If you change the configuration, you will need to restart Synapse. You'll also need
to restart Synapse to install the plugin.
to restart Synapse to install the plugin.

### Docker
Installations that use the Docker image of `synapse` that wish to use the synapse module require the `./mjolnir/synapse_antispam/mjolnir` project directory to be bind mounted into the `synapse` container's `/usr/local/lib/python3.11/site-packages/mjolnir` directory. Clone the project (`git clone https://github.com/matrix-org/mjolnir.git`), then use the following `docker-compose` block as an example.

```yaml
version: '3.7'
services:
synapse:
volumes:
- /<path>/mjolnir/synapse_antispam/mjolnir:/usr/local/lib/python3.11/site-packages/mjolnir
```
Loading