From 12b7cccbc656a257af2a8490ec488f54e1bfcfd5 Mon Sep 17 00:00:00 2001 From: Aaron Raimist Date: Fri, 10 May 2019 15:33:15 -0500 Subject: [PATCH 1/2] Mention the Synapse User Admin API on updating-users-passwords.md --- docs/updating-users-passwords.md | 14 ++++++++++++-- 1 file changed, 12 insertions(+), 2 deletions(-) diff --git a/docs/updating-users-passwords.md b/docs/updating-users-passwords.md index 72b1f2783..af8d38dcd 100644 --- a/docs/updating-users-passwords.md +++ b/docs/updating-users-passwords.md @@ -1,6 +1,14 @@ # Updating users passwords -If you are using the matrix-postgres container(default), you can do it via this Ansible playbook (make sure to edit the `` and `` part below): +## Option 1 + +Use the Synapse User Admin API as described here: https://github.com/matrix-org/synapse/blob/master/docs/admin_api/user_admin_api.rst#reset-password + +This requires an access token from a server admin account. If you didn't make your account a server admin when you created it, you can use the `/usr/local/bin/matrix-make-user-admin` script as described in [registering-users.md](registering-users.md). + +## Option 2 (if you are using the default matrix-postgres container): + +You can reset a user's password via the Ansible playbook (make sure to edit the `` and `` part below): ansible-playbook -i inventory/hosts setup.yml --extra-vars='username= password=' --tags=update-user-password @@ -8,7 +16,9 @@ If you are using the matrix-postgres container(default), you can do it via this **You can then log in with that user** via the riot-web service that this playbook has created for you at a URL like this: `https://riot./`. -If you are NOT using the matrix-postgres container, you can generate the password hash by using the command-line after **SSH**-ing to your server (requires that [all services have been started](#starting-the-services)): +## Option 3 (if you are using an external Postgres server): + +You can manually generate the password hash by using the command-line after **SSH**-ing to your server (requires that [all services have been started](installing.md#starting-the-services)): docker exec -it matrix-synapse /usr/local/bin/hash_password -c /data/homeserver.yaml From 59e05672d058a360b748a014ae9de4851b5a7f69 Mon Sep 17 00:00:00 2001 From: Aaron Raimist Date: Fri, 10 May 2019 15:38:22 -0500 Subject: [PATCH 2/2] Convert registering-users.md to use ``` syntax for code blocks The bit about the matrix-make-user-admin script was messed up (it wasn't actually a code block so the "" was hidden). For me at least it seems like the ``` syntax is much harder to accidentally mess up. --- docs/registering-users.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/docs/registering-users.md b/docs/registering-users.md index 9822979de..50dd92a96 100644 --- a/docs/registering-users.md +++ b/docs/registering-users.md @@ -4,11 +4,15 @@ Run this to create a new user account on your Matrix server. You can do it via this Ansible playbook (make sure to edit the `` and `` part below): - ansible-playbook -i inventory/hosts setup.yml --extra-vars='username= password= admin=' --tags=register-user +``` +ansible-playbook -i inventory/hosts setup.yml --extra-vars='username= password= admin=' --tags=register-user +``` **or** using the command-line after **SSH**-ing to your server (requires that [all services have been started](#starting-the-services)): - /usr/local/bin/matrix-synapse-register-user +``` +/usr/local/bin/matrix-synapse-register-user +``` **Note**: `` is just a plain username (like `john`), not your full `@:` identifier. @@ -25,5 +29,6 @@ The script `/usr/local/bin/matrix-make-user-admin` may be used to upgrade a user * log on to your server with ssh * execute with the username: - /usr/local/bin/matrix-make-user-admin - +``` +/usr/local/bin/matrix-make-user-admin +```