From 7e58c56e5f32126a0fbcfd613ace9c9b430300a4 Mon Sep 17 00:00:00 2001 From: A <32370941+aphick@users.noreply.github.com> Date: Mon, 5 May 2025 10:31:44 -0700 Subject: [PATCH] Update README.md --- conf/synapse/README.md | 19 ------------------- 1 file changed, 19 deletions(-) diff --git a/conf/synapse/README.md b/conf/synapse/README.md index e4d4dd3..eb5068f 100644 --- a/conf/synapse/README.md +++ b/conf/synapse/README.md @@ -7,22 +7,3 @@ This directory will contain the generate configuration for Synapse. ## Synapse & email It is recommended to configure an email account for Synapse, which can be used for email validation, and password resets. To do so, edit `homeserver.yaml` using the options available in the [official docs](https://element-hq.github.io/synapse/latest/usage/configuration/config_documentation.html#email), and then reload 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.