From 366fd7cdc4932288f60a7e211cacad3f6c73bc3f Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Fri, 22 Nov 2024 16:12:27 +0900 Subject: [PATCH] Update docs/registering-users.md and docs/updating-users-passwords.md: remove "your" from username and password placeholders 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 --- docs/registering-users.md | 16 ++++++++-------- docs/updating-users-passwords.md | 10 ++++++---- 2 files changed, 14 insertions(+), 12 deletions(-) diff --git a/docs/registering-users.md b/docs/registering-users.md index 62957adb4..3369b1f9d 100644 --- a/docs/registering-users.md +++ b/docs/registering-users.md @@ -1,6 +1,6 @@ # 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: @@ -15,8 +15,8 @@ Table of contents: ## Registering users manually **Notes**: -- Make sure to adjust `YOUR_USERNAME_HERE` and `YOUR_PASSWORD_HERE` -- For `YOUR_USERNAME_HERE`, use a plain username like `john`, not your full identifier (`@user:example.com`) +- 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`) - 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/`. @@ -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: ```sh -just register-user YOUR_USERNAME_HERE YOUR_PASSWORD_HERE +just register-user USERNAME_HERE PASSWORD_HERE # Example: `just register-user john secret-password yes` ``` @@ -36,7 +36,7 @@ just register-user YOUR_USERNAME_HERE YOUR_PASSWORD_HERE +/matrix/synapse/bin/register-user USERNAME_HERE PASSWORD_HERE # 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)): ```sh -/matrix/dendrite/bin/create-account YOUR_USERNAME_HERE YOUR_PASSWORD_HERE +/matrix/dendrite/bin/create-account USERNAME_HERE PASSWORD_HERE # 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)): ```sh -/matrix/matrix-authentication-service/bin/register-user YOUR_USERNAME_HERE YOUR_PASSWORD_HERE +/matrix/matrix-authentication-service/bin/register-user USERNAME_HERE 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 607537bb3..6461e1198 100644 --- a/docs/updating-users-passwords.md +++ b/docs/updating-users-passwords.md @@ -2,14 +2,16 @@ ## 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 `@: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/`.