Browse Source

Merge pull request #175 from aaronraimist/patch-2

Mention the Synapse User Admin API on updating-users-passwords.md
pull/177/head
Slavi Pantaleev 6 years ago
committed by GitHub
parent
commit
db39bfc2f5
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 21 additions and 6 deletions
  1. +9
    -4
      docs/registering-users.md
  2. +12
    -2
      docs/updating-users-passwords.md

+ 9
- 4
docs/registering-users.md View File

@@ -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 `<your-username>` and `<your-password>` part below): You can do it via this Ansible playbook (make sure to edit the `<your-username>` and `<your-password>` part below):


ansible-playbook -i inventory/hosts setup.yml --extra-vars='username=<your-username> password=<your-password> admin=<yes|no>' --tags=register-user
```
ansible-playbook -i inventory/hosts setup.yml --extra-vars='username=<your-username> password=<your-password> admin=<yes|no>' --tags=register-user
```


**or** using the command-line after **SSH**-ing to your server (requires that [all services have been started](#starting-the-services)): **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 <your-username> <your-password> <admin access: 0 or 1>
```
/usr/local/bin/matrix-synapse-register-user <your-username> <your-password> <admin access: 0 or 1>
```


**Note**: `<your-username>` is just a plain username (like `john`), not your full `@<username>:<your-domain>` identifier. **Note**: `<your-username>` is just a plain username (like `john`), not your full `@<username>:<your-domain>` 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 * log on to your server with ssh
* execute with the username: * execute with the username:


/usr/local/bin/matrix-make-user-admin <username>

```
/usr/local/bin/matrix-make-user-admin <username>
```

+ 12
- 2
docs/updating-users-passwords.md View File

@@ -1,6 +1,14 @@
# Updating users passwords # 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 `<your-username>` and `<your-password>` 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 `<your-username>` and `<your-password>` part below):


ansible-playbook -i inventory/hosts setup.yml --extra-vars='username=<your-username> password=<your-password>' --tags=update-user-password ansible-playbook -i inventory/hosts setup.yml --extra-vars='username=<your-username> password=<your-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.<domain>/`. **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.<domain>/`.


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 docker exec -it matrix-synapse /usr/local/bin/hash_password -c /data/homeserver.yaml




Loading…
Cancel
Save