From 6df0a9c3256803d7053faee5c9ffb117381188c4 Mon Sep 17 00:00:00 2001 From: A <32370941+aphick@users.noreply.github.com> Date: Thu, 5 Jun 2025 09:32:30 -0700 Subject: [PATCH] Update synapse.md --- docs/synapse.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/docs/synapse.md b/docs/synapse.md index f096b63..7858fde 100644 --- a/docs/synapse.md +++ b/docs/synapse.md @@ -19,5 +19,20 @@ user@dcomms-demo:~/dcomms-docker-compose# curl -X POST --header "Authorization: Once you have generated a registration token, this can be handed out to users and they can sign-up. +## Mjolnir + +Mjolnir is a mod tool for Synapse instances. We have included an example snippet and config for Mjolnir in conf/mjolnir/production.yaml and conf/compose/element.docker-compose.yml. + +### Deploying + +1. Register a mjolnir accounut as server admin. You can use one of the methods above. +2. Follow the steps in https://github.com/matrix-org/mjolnir/blob/main/docs/setup.md to retreive an access token +3. Populate the specified options in conf/mjolnir/production.yaml with your user and server information. +4. Uncomment the Mjolnir section in conf/compose/element.docker-compose.yml +5. Run `./run.sh` again. + +You should now be able to follow the post-installation steps in https://github.com/matrix-org/mjolnir/blob/main/docs/setup.md#post-install + # Links * Official docs: https://element-hq.github.io/synapse/latest/welcome_and_overview.html +* Matrix.org docs: https://matrix.org/docs/communities/moderation/