mirror/matrix-docker-ansible-deploy
1
0
Fork 0
mirror of https://github.com/spantaleev/matrix-docker-ansible-deploy.git synced 2025-03-13 16:20:28 +01:00
Code Issues Packages Projects Releases Wiki Activity

Update docs/registering-users.md and docs/updating-users-passwords.md: remove "your" from username and password placeholders

Browse Source 
These documentations, unlike docs/installing.md and docs/quick-start.md, describe how to handle users (registering them or changing their passwords), some of whom are yours, while others are not.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
This commit is contained in:
Suguru Hirahara 2024-11-22 16:12:27 +09:00
parent 713db870a7
commit 366fd7cdc4
No known key found for this signature in database
GPG Key ID: E4F9743DAB4B7B75
2 changed files with 14 additions and 12 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
docs/registering-users.md
View File

@ -1,6 +1,6 @@
# Registering users # Registering users
This documentation page tells you how to create user account on your Matrix server. This documentation page tells you how to create user accounts on your Matrix server.
Table of contents: Table of contents:
@ -15,8 +15,8 @@ Table of contents:
## Registering users manually ## Registering users manually
**Notes**: **Notes**:
- Make sure to adjust `YOUR_USERNAME_HERE` and `YOUR_PASSWORD_HERE` - Make sure to adjust `USERNAME_HERE` and `PASSWORD_HERE`
- For `YOUR_USERNAME_HERE`, use a plain username like `john`, not your full identifier (`@user:example.com`) - For `USERNAME_HERE`, use a plain username like `john`, not a full identifier (`@user:example.com`)
- Use `admin=yes` or `admin=no` depending on whether you wish to make the user an administrator of the Matrix server - Use `admin=yes` or `admin=no` depending on whether you wish to make the user an administrator of the Matrix server
After registering a user (using one of the methods below), **you can log in with that user** via the [Element Web](configuring-playbook-client-element-web.md) service that this playbook has installed for you at a URL like this: `https://element.example.com/`. After registering a user (using one of the methods below), **you can log in with that user** via the [Element Web](configuring-playbook-client-element-web.md) service that this playbook has installed for you at a URL like this: `https://element.example.com/`.
@ -28,7 +28,7 @@ It's best to register users via the Ansible playbook, because it works regardles
To register a user via this Ansible playbook: To register a user via this Ansible playbook:
```sh ```sh
just register-user YOUR_USERNAME_HERE YOUR_PASSWORD_HERE <admin access: yes or no> just register-user USERNAME_HERE PASSWORD_HERE <admin access: yes or no>
# Example: `just register-user john secret-password yes` # Example: `just register-user john secret-password yes`
``` ```
@ -36,7 +36,7 @@ just register-user YOUR_USERNAME_HERE YOUR_PASSWORD_HERE <admin access: yes or n
**or** by invoking `ansible-playbook` manually: **or** by invoking `ansible-playbook` manually:
```sh ```sh
ansible-playbook -i inventory/hosts setup.yml --extra-vars='username=YOUR_USERNAME_HERE password=YOUR_PASSWORD_HERE admin=<yes|no>' --tags=register-user ansible-playbook -i inventory/hosts setup.yml --extra-vars='username=USERNAME_HERE password=PASSWORD_HERE admin=<yes|no>' --tags=register-user
# Example: ansible-playbook -i inventory/hosts setup.yml --extra-vars='username=john password=secret-password admin=yes' --tags=register-user # Example: ansible-playbook -i inventory/hosts setup.yml --extra-vars='username=john password=secret-password admin=yes' --tags=register-user
``` ```
@ -48,7 +48,7 @@ ansible-playbook -i inventory/hosts setup.yml --extra-vars='username=YOUR_USERNA
If you're using the [Synapse](configuring-playbook-synapse.md) homeserver implementation (which is the default), you can register users via the command-line after **SSH**-ing to your server (requires that [all services have been started](#starting-the-services)): If you're using the [Synapse](configuring-playbook-synapse.md) homeserver implementation (which is the default), you can register users via the command-line after **SSH**-ing to your server (requires that [all services have been started](#starting-the-services)):
```sh ```sh
/matrix/synapse/bin/register-user YOUR_USERNAME_HERE YOUR_PASSWORD_HERE <admin access: 0 or 1> /matrix/synapse/bin/register-user USERNAME_HERE PASSWORD_HERE <admin access: 0 or 1>
# Example: `/matrix/synapse/bin/register-user john secret-password 1` # Example: `/matrix/synapse/bin/register-user john secret-password 1`
``` ```
@ -58,7 +58,7 @@ If you're using the [Synapse](configuring-playbook-synapse.md) homeserver implem
If you're using the [Dendrite](./configuring-playbook-dendrite.md) homeserver implementation, you can register users via the command-line after **SSH**-ing to your server (requires that [all services have been started](#starting-the-services)): If you're using the [Dendrite](./configuring-playbook-dendrite.md) homeserver implementation, you can register users via the command-line after **SSH**-ing to your server (requires that [all services have been started](#starting-the-services)):
```sh ```sh
/matrix/dendrite/bin/create-account YOUR_USERNAME_HERE YOUR_PASSWORD_HERE <admin access: 0 or 1> /matrix/dendrite/bin/create-account USERNAME_HERE PASSWORD_HERE <admin access: 0 or 1>
# Example: `/matrix/dendrite/bin/create-account john secret-password 1` # Example: `/matrix/dendrite/bin/create-account john secret-password 1`
``` ```
@ -68,7 +68,7 @@ If you're using the [Dendrite](./configuring-playbook-dendrite.md) homeserver im
If you're using the [Matrix Authentication Service](./configuring-playbook-matrix-authentication-service.md) and your existing homeserver (most likely [Synapse](./configuring-playbook-synapse.md)) is delegating authentication to it, you can register users via the command-line after **SSH**-ing to your server (requires that [all services have been started](#starting-the-services)): If you're using the [Matrix Authentication Service](./configuring-playbook-matrix-authentication-service.md) and your existing homeserver (most likely [Synapse](./configuring-playbook-synapse.md)) is delegating authentication to it, you can register users via the command-line after **SSH**-ing to your server (requires that [all services have been started](#starting-the-services)):
```sh ```sh
/matrix/matrix-authentication-service/bin/register-user YOUR_USERNAME_HERE YOUR_PASSWORD_HERE <admin access: 0 or 1> /matrix/matrix-authentication-service/bin/register-user USERNAME_HERE PASSWORD_HERE <admin access: 0 or 1>
# Example: `/matrix/matrix-authentication-service/bin/register-user john secret-password 1` # Example: `/matrix/matrix-authentication-service/bin/register-user john secret-password 1`
``` ```

10
docs/updating-users-passwords.md
View File

@ -2,14 +2,16 @@
## Option 1 (if you are using the integrated Postgres database): ## Option 1 (if you are using the integrated Postgres database):
You can reset a user's password via the Ansible playbook (make sure to edit the `YOUR_USERNAME_HERE` and `YOUR_PASSWORD_HERE` part below): **Notes**:
- Make sure to adjust `USERNAME_HERE` and `PASSWORD_HERE`
- For `USERNAME_HERE`, use a plain username like `john`, not a full identifier (`@user:example.com`)
You can reset a user's password via the Ansible playbook:
``` ```
ansible-playbook -i inventory/hosts setup.yml --extra-vars='username=YOUR_USERNAME_HERE password=YOUR_PASSWORD_HERE' --tags=update-user-password ansible-playbook -i inventory/hosts setup.yml --extra-vars='username=USERNAME_HERE password=PASSWORD_HERE' --tags=update-user-password
``` ```
**Note**: `YOUR_USERNAME_HERE` is just a plain username (like `john`), not your full `@<username>:example.com` identifier.
**You can then log in with that user** via Element Web that this playbook has created for you at a URL like this: `https://element.example.com/`. **You can then log in with that user** via Element Web that this playbook has created for you at a URL like this: `https://element.example.com/`.