diff options
| author | Michael Kaye <1917473+michaelkaye@users.noreply.github.com> | 2020-07-17 18:25:48 +0100 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2020-07-17 13:25:48 -0400 |
| commit | 1ec2961b3b214c7af4b541396adc94948b626c47 (patch) | |
| tree | 6cdfd1a84d2607a34ec2ef135967ef65a014124c | |
| parent | Switch to Debian:Slim from Alpine for the docker image (#7839) (diff) | |
| download | synapse-1ec2961b3b214c7af4b541396adc94948b626c47.tar.xz | |
Add help for creating a user via docker (#7885)
| -rw-r--r-- | changelog.d/7885.doc | 1 | ||||
| -rw-r--r-- | docker/README.md | 15 |
2 files changed, 16 insertions, 0 deletions
diff --git a/changelog.d/7885.doc b/changelog.d/7885.doc new file mode 100644 index 0000000000..cbe9de4082 --- /dev/null +++ b/changelog.d/7885.doc @@ -0,0 +1 @@ +Provide instructions on using `register_new_matrix_user` via docker. diff --git a/docker/README.md b/docker/README.md index 8c337149ca..008a9ff708 100644 --- a/docker/README.md +++ b/docker/README.md @@ -94,6 +94,21 @@ The following environment variables are supported in run mode: * `UID`, `GID`: the user and group id to run Synapse as. Defaults to `991`, `991`. * `TZ`: the [timezone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) the container will run with. Defaults to `UTC`. +## Generating an (admin) user + +After synapse is running, you may wish to create a user via `register_new_matrix_user`. + +This requires a `registration_shared_secret` to be set in your config file. Synapse +must be restarted to pick up this change. + +You can then call the script: + +``` +docker exec -it synapse register_new_matrix_user http://localhost:8008 -c /data/homeserver.yaml --help +``` + +Remember to remove the `registration_shared_secret` and restart if you no-longer need it. + ## TLS support The default configuration exposes a single HTTP port: http://localhost:8008. It |