From 173a78a839e148fd0b07b8a0ffcbcbc921b19e26 Mon Sep 17 00:00:00 2001
From: A <32370941+aphick@users.noreply.github.com>
Date: Mon, 5 May 2025 10:31:27 -0700
Subject: [PATCH] Create synapse.md

---
 docs/synapse.md | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)
 create mode 100644 docs/synapse.md

diff --git a/docs/synapse.md b/docs/synapse.md
new file mode 100644
index 0000000..f096b63
--- /dev/null
+++ b/docs/synapse.md
@@ -0,0 +1,23 @@
+# Synapse
+
+## Creating an admin user
+
+To create an admin user use the command [register_new_matrix_user](https://manpages.debian.org/testing/matrix-synapse/register_new_matrix_user.1.en.html) within the `compose-synapse` Docker container. Example:
+
+```
+register_new_matrix_user -u dcomms-admin --admin -c /data/homeserver.yaml
+```
+
+## User registration and registration tokens
+
+By default, Synapse is configured to require registration tokens to sign up. Synapse servers with open registrations are strongly discouraged, as they can result in severe spam and abuse. To generate a registration token you can follow the official API docs to [API access token](https://element-hq.github.io/synapse/latest/usage/administration/admin_api/index.html#making-an-admin-api-request), and then also to [generate a registration token](https://element-hq.github.io/synapse/latest/usage/administration/admin_api/registration_tokens.html). Example from cli of the dComms host:
+
+```curl
+user@dcomms-demo:~/dcomms-docker-compose# curl -X POST --header "Authorization: Bearer syt_abc123" http://localhost:8008/_synapse/admin/v1/registration_tokens/new -d '{}'
+{"token":"abc123","uses_allowed":null,"pending":0,"completed":0,"expiry_time":null}
+```
+
+Once you have generated a registration token, this can be handed out to users and they can sign-up.
+
+# Links
+* Official docs: https://element-hq.github.io/synapse/latest/welcome_and_overview.html