summary refs log tree commit diff
diff options
context:
space:
mode:
authorblakehawkins <blakehawkins@users.noreply.github.com>2021-03-29 17:05:06 +0100
committerGitHub <noreply@github.com>2021-03-29 17:05:06 +0100
commit7dcf3fd2212b60b1b51bf9c699c4e58e8bd121fb (patch)
tree29b1a175aa2bd5063f8607ae0f0a88a52995c8ba
parentAdd type hints for the federation sender. (#9681) (diff)
downloadsynapse-7dcf3fd2212b60b1b51bf9c699c4e58e8bd121fb.tar.xz
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
-rw-r--r--INSTALL.md26
-rw-r--r--changelog.d/9074.doc1
2 files changed, 19 insertions, 8 deletions
diff --git a/INSTALL.md b/INSTALL.md
index 59318cb087..808243719e 100644
--- a/INSTALL.md
+++ b/INSTALL.md
@@ -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/).
 
-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:
diff --git a/changelog.d/9074.doc b/changelog.d/9074.doc
new file mode 100644
index 0000000000..57f7c97a6e
--- /dev/null
+++ b/changelog.d/9074.doc
@@ -0,0 +1 @@
+Clarify that register_new_matrix_user is present also when installed via non-pip package.