Skip to content
This repository was archived by the owner on Apr 26, 2024. It is now read-only.

Commit 7dcf3fd

Browse files
authored
Clarify that register_new_matrix_user is present also when installed via non-pip package (#9074)
Signed-off-by: blakehawkins [email protected]
1 parent da75d2e commit 7dcf3fd

File tree

2 files changed

+19
-8
lines changed

2 files changed

+19
-8
lines changed

INSTALL.md

Lines changed: 18 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -527,14 +527,24 @@ email will be disabled.
527527

528528
The easiest way to create a new user is to do so from a client like [Element](https://element.io/).
529529

530-
Alternatively you can do so from the command line if you have installed via pip.
531-
532-
This can be done as follows:
533-
534-
```sh
535-
$ source ~/synapse/env/bin/activate
536-
$ synctl start # if not already running
537-
$ register_new_matrix_user -c homeserver.yaml http://localhost:8008
530+
Alternatively, you can do so from the command line. This can be done as follows:
531+
532+
1. If synapse was installed via pip, activate the virtualenv as follows (if Synapse was
533+
installed via a prebuilt package, `register_new_matrix_user` should already be
534+
on the search path):
535+
```sh
536+
cd ~/synapse
537+
source env/bin/activate
538+
synctl start # if not already running
539+
```
540+
2. Run the following command:
541+
```sh
542+
register_new_matrix_user -c homeserver.yaml http://localhost:8008
543+
```
544+
545+
This will prompt you to add details for the new user, and will then connect to
546+
the running Synapse to create the new user. For example:
547+
```
538548
New user localpart: erikj
539549
Password:
540550
Confirm password:

changelog.d/9074.doc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Clarify that register_new_matrix_user is present also when installed via non-pip package.

0 commit comments

Comments
 (0)