From 492f674b954e936858c7b8df623ffbdc3b60238b Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Sat, 23 Nov 2024 00:38:09 +0900 Subject: [PATCH] Remove a line about setting "admin=yes" to reduce the amount of information Because quick-start.md is getting longer with much information, it removes the note in favor of the linked registering-users.md documentation. The note is available on installing.md as well, and details about adding user accounts for other people can (and should) be checked on those documentations. Also, this commit edits lines above these notes to make it clear that your user account will be an administrator of the server. With this commit, the amount of the information about adding user accounts will be: registering-users.md > installing.md > quick-start.md Signed-off-by: Suguru Hirahara --- docs/installing.md | 2 +- docs/quick-start.md | 7 +++++-- 2 files changed, 6 insertions(+), 3 deletions(-) diff --git a/docs/installing.md b/docs/installing.md index 5c2154941..41d66d9c3 100644 --- a/docs/installing.md +++ b/docs/installing.md @@ -77,7 +77,7 @@ As you have configured your brand new server and the client, you need to **creat After creating the user account, you can log in to it with [Element Web](configuring-playbook-client-element-web.md) that this playbook has installed for you at this URL: `https://element.example.com/`. -To create your user account via this Ansible playbook, run the command below on your local computer. +To create your user account (as an administrator of the server) via this Ansible playbook, run the command below on your local computer. **Notes**: - Make sure to adjust `YOUR_USERNAME_HERE` and `YOUR_PASSWORD_HERE` diff --git a/docs/quick-start.md b/docs/quick-start.md index 509ff9b44..50564a05c 100644 --- a/docs/quick-start.md +++ b/docs/quick-start.md @@ -129,12 +129,11 @@ Wait until the command completes. If it's all green, everything should be runnin As you have configured your brand new server and the client, you need to **create your user account** on your Matrix server. -To create your user account via this Ansible playbook, run the command below on your local computer. +To create your user account (as an administrator of the server) via this Ansible playbook, run the command below on your local computer. **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`) -- Use `admin=yes` to make your user account an administrator of the Matrix server ```sh ansible-playbook -i inventory/hosts setup.yml --extra-vars='username=YOUR_USERNAME_HERE password=YOUR_PASSWORD_HERE admin=yes' --tags=register-user @@ -142,6 +141,10 @@ ansible-playbook -i inventory/hosts setup.yml --extra-vars='username=YOUR_USERNA # Example: ansible-playbook -i inventory/hosts setup.yml --extra-vars='username=john password=secret-password admin=yes' --tags=register-user ``` + + ## Finalize server installation This section is optimized for this quick-start guide and is derived from the following full-documentation page: [Server Delegation](howto-server-delegation.md)