Clarify that register_new_matrix_user is present also when installed via non-pip package (#9074)

Signed-off-by: blakehawkins blake.hawkins.11@gmail.com
This commit is contained in:
blakehawkins 2021-03-29 17:05:06 +01:00 committed by GitHub
parent da75d2ea1f
commit 7dcf3fd221
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 17 additions and 6 deletions

View File

@ -527,14 +527,24 @@ email will be disabled.
The easiest way to create a new user is to do so from a client like [Element](https://element.io/). The easiest way to create a new user is to do so from a client like [Element](https://element.io/).
Alternatively you can do so from the command line if you have installed via pip. Alternatively, you can do so from the command line. This can be done as follows:
This can be done as follows: 1. If synapse was installed via pip, activate the virtualenv as follows (if Synapse was
installed via a prebuilt package, `register_new_matrix_user` should already be
on the search path):
```sh
cd ~/synapse
source env/bin/activate
synctl start # if not already running
```
2. Run the following command:
```sh
register_new_matrix_user -c homeserver.yaml http://localhost:8008
```
```sh This will prompt you to add details for the new user, and will then connect to
$ source ~/synapse/env/bin/activate the running Synapse to create the new user. For example:
$ synctl start # if not already running ```
$ register_new_matrix_user -c homeserver.yaml http://localhost:8008
New user localpart: erikj New user localpart: erikj
Password: Password:
Confirm password: Confirm password:

1
changelog.d/9074.doc Normal file
View File

@ -0,0 +1 @@
Clarify that register_new_matrix_user is present also when installed via non-pip package.