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

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

Merged
merged 6 commits into from
Mar 29, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 18 additions & 8 deletions INSTALL.md
Original file line number Diff line number Diff line change
Expand Up @@ -539,14 +539,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/).

Alternatively you can do so from the command line if you have installed via pip.

This can be done as follows:

```sh
$ source ~/synapse/env/bin/activate
$ synctl start # if not already running
$ register_new_matrix_user -c homeserver.yaml http://localhost:8008
Alternatively, you can do so from the command line. 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
```

This will prompt you to add details for the new user, and will then connect to
the running Synapse to create the new user. For example:
```
New user localpart: erikj
Password:
Confirm password:
Expand Down
1 change: 1 addition & 0 deletions changelog.d/9074.doc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Clarify that register_new_matrix_user is present also when installed via non-pip package.