Skip to content
Snippets Groups Projects
Unverified Commit 1ec2961b authored by Michael Kaye's avatar Michael Kaye Committed by GitHub
Browse files

Add help for creating a user via docker (#7885)

parent a5545cf8
No related branches found
No related tags found
No related merge requests found
Provide instructions on using `register_new_matrix_user` via docker.
...@@ -94,6 +94,21 @@ The following environment variables are supported in run mode: ...@@ -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`. * `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`. * `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 ## TLS support
The default configuration exposes a single HTTP port: http://localhost:8008. It The default configuration exposes a single HTTP port: http://localhost:8008. It
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment