From 26d5ec9a463a78d63523a99e2780a9f3c136ab11 Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Sun, 17 Nov 2024 01:59:41 +0900 Subject: [PATCH] Replace with YOUR_PASSWORD_HERE Signed-off-by: Suguru Hirahara --- docs/quick-start.md | 4 ++-- docs/registering-users.md | 12 ++++++------ docs/updating-users-passwords.md | 4 ++-- 3 files changed, 10 insertions(+), 10 deletions(-) diff --git a/docs/quick-start.md b/docs/quick-start.md index 892ece049..2c95e1329 100644 --- a/docs/quick-start.md +++ b/docs/quick-start.md @@ -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_HERE` and `` +- Before running it, make sure to edit `YOUR_USERNAME_HERE` and `YOUR_PASSWORD_HERE` - 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_HERE password= admin=' --tags=register-user +ansible-playbook -i inventory/hosts setup.yml --extra-vars='username=YOUR_USERNAME_HERE password=YOUR_PASSWORD_HERE admin=' --tags=register-user # Example: `ansible-playbook -i inventory/hosts setup.yml --extra-vars='username=john password=secret-password admin=yes' --tags=register-user` ``` diff --git a/docs/registering-users.md b/docs/registering-users.md index bc8b4a25d..5d0c48624 100644 --- a/docs/registering-users.md +++ b/docs/registering-users.md @@ -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_HERE` and `` part below): +To register a user via this Ansible playbook (make sure to edit the `YOUR_USERNAME_HERE` and `YOUR_PASSWORD_HERE` part below): ```sh -just register-user YOUR_USERNAME_HERE +just register-user YOUR_USERNAME_HERE YOUR_PASSWORD_HERE # Example: `just register-user john secret-password yes` ``` @@ -33,7 +33,7 @@ just register-user YOUR_USERNAME_HERE **or** by invoking `ansible-playbook` manually: ```sh -ansible-playbook -i inventory/hosts setup.yml --extra-vars='username=YOUR_USERNAME_HERE password= admin=' --tags=register-user +ansible-playbook -i inventory/hosts setup.yml --extra-vars='username=YOUR_USERNAME_HERE password=YOUR_PASSWORD_HERE admin=' --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_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)): ```sh -/matrix/synapse/bin/register-user YOUR_USERNAME_HERE +/matrix/synapse/bin/register-user YOUR_USERNAME_HERE YOUR_PASSWORD_HERE # 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_HERE +/matrix/dendrite/bin/create-account YOUR_USERNAME_HERE YOUR_PASSWORD_HERE # 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_HERE +/matrix/matrix-authentication-service/bin/register-user YOUR_USERNAME_HERE YOUR_PASSWORD_HERE # Example: `/matrix/matrix-authentication-service/bin/register-user john secret-password 1` ``` diff --git a/docs/updating-users-passwords.md b/docs/updating-users-passwords.md index 331e67262..607537bb3 100644 --- a/docs/updating-users-passwords.md +++ b/docs/updating-users-passwords.md @@ -2,10 +2,10 @@ ## 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 `` part below): +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): ``` -ansible-playbook -i inventory/hosts setup.yml --extra-vars='username=YOUR_USERNAME_HERE password=' --tags=update-user-password +ansible-playbook -i inventory/hosts setup.yml --extra-vars='username=YOUR_USERNAME_HERE password=YOUR_PASSWORD_HERE' --tags=update-user-password ``` **Note**: `YOUR_USERNAME_HERE` is just a plain username (like `john`), not your full `@:example.com` identifier.