From d12129ee451cf48db86646d9991ef7247edbef85 Mon Sep 17 00:00:00 2001 From: th0mcat <37344783+th0mcat@users.noreply.github.com> Date: Mon, 14 Oct 2024 09:21:36 -0500 Subject: [PATCH] Add instructions for bind mounting the synapse module into a Docker installation of synapse --- docs/synapse_module.md | 13 ++++++++++++- 1 file changed, 12 insertions(+), 1 deletion(-) diff --git a/docs/synapse_module.md b/docs/synapse_module.md index 56c7fa12..1c49c3a6 100644 --- a/docs/synapse_module.md +++ b/docs/synapse_module.md @@ -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. \ No newline at end of file +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: + - //mjolnir/synapse_antispam/mjolnir:/usr/local/lib/python3.11/site-packages/mjolnir +```