docker-compose/docs/synapse.md
2025-05-05 10:31:27 -07:00

1.4 KiB

Synapse

Creating an admin user

To create an admin user use the command register_new_matrix_user 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, and then also to generate a registration token. Example from cli of the dComms host:

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