From 91ad7c3e5a913c702ac7ec43415e7336614a8897 Mon Sep 17 00:00:00 2001 From: blakehawkins Date: Mon, 11 Jan 2021 22:40:20 +0000 Subject: [PATCH 1/6] Clarify that register_new_matrix_user is present also when installed via non-pip package --- INSTALL.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/INSTALL.md b/INSTALL.md index 656833637c36..9746a9b6d938 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -539,13 +539,16 @@ 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. +Alternatively, you can do so from the command line if you have installed synapse via package. This can be done as follows: ```sh +$ # These steps are needed if installed via pip. $ source ~/synapse/env/bin/activate $ synctl start # if not already running +$ +$ # This executable is present when installed via any package. $ register_new_matrix_user -c homeserver.yaml http://localhost:8008 New user localpart: erikj Password: From 26a749bd31ad58d8d261b8a5925248fea996b91c Mon Sep 17 00:00:00 2001 From: blakehawkins Date: Sat, 20 Feb 2021 22:20:35 +0000 Subject: [PATCH 2/6] cr --- INSTALL.md | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/INSTALL.md b/INSTALL.md index 9746a9b6d938..e18ffccc4d35 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -539,16 +539,15 @@ 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 synapse via package. - -This can be done as follows: +Alternatively, you can do so from the command line. This can be done as follows: ```sh -$ # These steps are needed if installed via pip. +$ # These steps are needed if synapse was installed via pip. $ source ~/synapse/env/bin/activate $ synctl start # if not already running $ -$ # This executable is present when installed via any package. +$ # If synapse was installed via a prebuilt package, register_new_matrix_user +$ # should already be on the search path. $ register_new_matrix_user -c homeserver.yaml http://localhost:8008 New user localpart: erikj Password: From 79f3baa26fbe1b9b23a3d2a15ef3fb9cc38657a7 Mon Sep 17 00:00:00 2001 From: blakehawkins Date: Sat, 20 Feb 2021 22:24:30 +0000 Subject: [PATCH 3/6] towncrier --- changelog.d/9074.doc | 1 + 1 file changed, 1 insertion(+) create mode 100644 changelog.d/9074.doc diff --git a/changelog.d/9074.doc b/changelog.d/9074.doc new file mode 100644 index 000000000000..57f7c97a6e61 --- /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. From 778cf70fe8fa90221e25a3f4ff0da569171c6468 Mon Sep 17 00:00:00 2001 From: Richard van der Hoff <1389908+richvdh@users.noreply.github.com> Date: Mon, 29 Mar 2021 16:59:31 +0100 Subject: [PATCH 4/6] Update INSTALL.md --- INSTALL.md | 21 +++++++++++++-------- 1 file changed, 13 insertions(+), 8 deletions(-) diff --git a/INSTALL.md b/INSTALL.md index e18ffccc4d35..12d66efa716d 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -541,14 +541,19 @@ The easiest way to create a new user is to do so from a client like [Element](ht Alternatively, you can do so from the command line. This can be done as follows: -```sh -$ # These steps are needed if synapse was installed via pip. -$ source ~/synapse/env/bin/activate -$ synctl start # if not already running -$ -$ # If synapse was installed via a prebuilt package, register_new_matrix_user -$ # should already be on the search path. -$ register_new_matrix_user -c homeserver.yaml http://localhost:8008 + 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. ```sh + register_new_matrix_user -c homeserver.yaml http://localhost:8008 + ``` + +This will prompt you to add details for the new user. For example: New user localpart: erikj Password: Confirm password: From b98c6a5df4bf3b39b9d0dd3e4d7cc42766714156 Mon Sep 17 00:00:00 2001 From: Richard van der Hoff <1389908+richvdh@users.noreply.github.com> Date: Mon, 29 Mar 2021 17:00:41 +0100 Subject: [PATCH 5/6] Update INSTALL.md --- INSTALL.md | 1 + 1 file changed, 1 insertion(+) diff --git a/INSTALL.md b/INSTALL.md index 12d66efa716d..6c53bbc7b233 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -554,6 +554,7 @@ Alternatively, you can do so from the command line. This can be done as follows: ``` This will prompt you to add details for the new user. For example: +``` New user localpart: erikj Password: Confirm password: From 992f3b976275a6627113438a688e698d34bfaae2 Mon Sep 17 00:00:00 2001 From: Richard van der Hoff <1389908+richvdh@users.noreply.github.com> Date: Mon, 29 Mar 2021 17:02:42 +0100 Subject: [PATCH 6/6] Update INSTALL.md --- INSTALL.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/INSTALL.md b/INSTALL.md index 6c53bbc7b233..dd46aa43b047 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -549,11 +549,13 @@ Alternatively, you can do so from the command line. This can be done as follows: source env/bin/activate synctl start # if not already running ``` - 2. ```sh + 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. For example: +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: