From 92c6031c9f19ca609e71fe3e411752a1c4a78d91 Mon Sep 17 00:00:00 2001 From: prasket Date: Mon, 20 Jan 2020 12:59:36 -0800 Subject: [PATCH] changes to the docs for the new admin modifcation scripts --- docs/registering-users.md | 5 ++++- docs/updating-users-passwords.md | 9 ++++++--- 2 files changed, 10 insertions(+), 4 deletions(-) diff --git a/docs/registering-users.md b/docs/registering-users.md index d5ddc6c7..cf0ede41 100644 --- a/docs/registering-users.md +++ b/docs/registering-users.md @@ -24,7 +24,10 @@ If you've just installed Matrix, **to finalize the installation process**, it's ----- -The script `/usr/local/bin/matrix-change-user-admin-status` may be used to change a user's admin privileges: + +## Adding/Removing Administrator privileges to an existing user. + +The script `/usr/local/bin/matrix-change-user-admin-status` may be used to change a user's admin privileges. * log on to your server with ssh * execute with the username and 0/1 (0 = non-admin | 1 = admin) diff --git a/docs/updating-users-passwords.md b/docs/updating-users-passwords.md index 90dfb64e..698405b4 100644 --- a/docs/updating-users-passwords.md +++ b/docs/updating-users-passwords.md @@ -2,10 +2,11 @@ ## Option 1 (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): +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 +ansible-playbook -i inventory/hosts setup.yml --extra-vars='user:w +name= password=' --tags=update-user-password ``` **Note**: `` is just a plain username (like `john`), not your full `@:` identifier. @@ -34,7 +35,9 @@ where `` is the hash returned by the docker command above. 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-change-user-admin-status` script as described in [registering-users.md](registering-users.md). Note this method will also log the user out of all of their clients while the other options do not. +This requires an access token from a server admin account. *This method will also log the user out of all of their clients while the other options do not.* + +If you didn't make your account a server admin when you created it, you can use the `/usr/local/bin/matrix-change-user-admin-status` script as described in [registering-users.md](registering-users.md). ### Example: To set @user:domain.com's password to `correct_horse_battery_staple` you could use this curl command: