caparazondigital/docker-compose
2
1
Fork 0
Code Issues 3 Pull Requests Actions Packages Projects Releases Wiki Activity

Create synapse.md

Browse Source
This commit is contained in:
A 2025-05-05 10:31:27 -07:00 committed by GitHub
parent ee1afca6b7
commit 173a78a839
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 23 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
docs/synapse.md Normal file
View File

@ -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