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

Replace <your-username> with YOUR_USERNAME_HERE

Browse Source 
This is a common expression and should avoid misunderstanding that `<` and `>` would need to be included

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
This commit is contained in:
Suguru Hirahara 2024-11-17 01:58:21 +09:00
parent 27ede17d3a
commit 4bf5f30fbd
No known key found for this signature in database
GPG Key ID: E4F9743DAB4B7B75
3 changed files with 13 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/quick-start.md
View File

@ -108,11 +108,11 @@ As you have configured your brand new server and the client, you need to **creat
To register a user via this Ansible playbook, run the command below on your local computer.
**Notes**:
- Before running it, make sure to edit `<your-username>` and `<your-password>`
- In the command below, `<your-username>` is just a plain username (like `john`), not your full `@user:example.com` identifier
- Before running it, make sure to edit `YOUR_USERNAME_HERE` and `<your-password>`
- In the command below, `YOUR_USERNAME_HERE` is just a plain username (like `john`), not your full `@user:example.com` identifier
```sh
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_HERE password=<your-password> 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`
```

14
docs/registering-users.md
View File

@ -14,7 +14,7 @@ Table of contents:
## Registering users manually
**Note**: in the commands below, `<your-username>` is just a plain username (like `john`), not your full `@<username>:example.com` identifier.
**Note**: in the commands below, `YOUR_USERNAME_HERE` is just a plain username (like `john`), not your full `@<username>:example.com` identifier.
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/`.
@ -22,10 +22,10 @@ After registering a user (using one of the methods below), **you can log in with
It's best to register users via the Ansible playbook, because it works regardless of homeserver implementation (Synapse, Dendrite, etc) or usage of [Matrix Authentication Service](configuring-playbook-matrix-authentication-service.md) (MAS).
To register a user via this Ansible playbook (make sure to edit the `<your-username>` and `<your-password>` part below):
To register a user via this Ansible playbook (make sure to edit the `YOUR_USERNAME_HERE` and `<your-password>` part below):
```sh
just register-user <your-username> <your-password> <admin access: yes or no>
just register-user YOUR_USERNAME_HERE <your-password> <admin access: yes or no>
# Example: `just register-user john secret-password yes`
```
@ -33,7 +33,7 @@ just register-user <your-username> <your-password> <admin access: yes or no>
**or** by invoking `ansible-playbook` manually:
```sh
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_HERE password=<your-password> 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`
```
@ -45,7 +45,7 @@ ansible-playbook -i inventory/hosts setup.yml --extra-vars='username=<your-usern
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
/matrix/synapse/bin/register-user <your-username> <your-password> <admin access: 0 or 1>
/matrix/synapse/bin/register-user YOUR_USERNAME_HERE <your-password> <admin access: 0 or 1>
# Example: `/matrix/synapse/bin/register-user john secret-password 1`
```
@ -55,7 +55,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)):
```sh
/matrix/dendrite/bin/create-account <your-username> <your-password> <admin access: 0 or 1>
/matrix/dendrite/bin/create-account YOUR_USERNAME_HERE <your-password> <admin access: 0 or 1>
# Example: `/matrix/dendrite/bin/create-account john secret-password 1`
```
@ -65,7 +65,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)):
```sh
/matrix/matrix-authentication-service/bin/register-user <your-username> <your-password> <admin access: 0 or 1>
/matrix/matrix-authentication-service/bin/register-user YOUR_USERNAME_HERE <your-password> <admin access: 0 or 1>
# Example: `/matrix/matrix-authentication-service/bin/register-user john secret-password 1`
```

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

@ -2,13 +2,13 @@
## 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>` and `<your-password>` part below):
You can reset a user's password via the Ansible playbook (make sure to edit the `YOUR_USERNAME_HERE` 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_HERE password=<your-password>' --tags=update-user-password
```
**Note**: `<your-username>` is just a plain username (like `john`), not your full `@<username>:example.com` identifier.
**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/`.