diff --git a/docs/installing.md b/docs/installing.md index 63d3f3ddd..5c2154941 100644 --- a/docs/installing.md +++ b/docs/installing.md @@ -80,16 +80,18 @@ After creating the user account, you can log in to it with [Element Web](configu To create your user account via this Ansible playbook, run the command below on your local computer. **Notes**: -- Make sure to edit `YOUR_USERNAME_HERE` and `YOUR_PASSWORD_HERE` -- To `YOUR_USERNAME_HERE`, set a plain username like `john`, not your full `@user:example.com` identifier -- Set `admin=yes` to make the user an administrator of the Matrix server +- 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=' --tags=register-user +ansible-playbook -i inventory/hosts setup.yml --extra-vars='username=YOUR_USERNAME_HERE password=YOUR_PASSWORD_HERE 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 ``` +Feel free to create as many accounts (for friends, family, etc.) as you want. Still, perhaps you should grant full administrative access to your account only (with `admin=yes`), and others should be created with `admin=no`. + For more information, see the documentation for [registering users](registering-users.md). ## Finalize the installation diff --git a/docs/quick-start.md b/docs/quick-start.md index a0ebc58cd..509ff9b44 100644 --- a/docs/quick-start.md +++ b/docs/quick-start.md @@ -134,16 +134,14 @@ To create your user account via this Ansible playbook, run the command below on **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` or `admin=no` depending on whether you wish to make the user an administrator of the Matrix server +- 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=' --tags=register-user +ansible-playbook -i inventory/hosts setup.yml --extra-vars='username=YOUR_USERNAME_HERE password=YOUR_PASSWORD_HERE 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 ``` -ℹ️ *For an instruction to add other user accounts than yours, see [Registering users](registering-users.md).* - ## 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) diff --git a/docs/registering-users.md b/docs/registering-users.md index 3369b1f9d..0542aaa06 100644 --- a/docs/registering-users.md +++ b/docs/registering-users.md @@ -41,6 +41,8 @@ ansible-playbook -i inventory/hosts setup.yml --extra-vars='username=USERNAME_HE # Example: ansible-playbook -i inventory/hosts setup.yml --extra-vars='username=john password=secret-password admin=yes' --tags=register-user ``` +Feel free to register as many users (for friends, family, etc.) as you want. Still, perhaps you should grant full administrative access to your user account only (with `admin=yes`), and others should be created with `admin=no`. + ⚠ **Warning**: If you're registering users against Matrix Authentication Service, do note that it [still insists](https://github.com/element-hq/matrix-authentication-service/issues/1505) on having a verified email address for each user. Upon a user's first login, they will be asked to confirm their email address. This requires that email sending is [configured](./configuring-playbook-email.md). You can also consult the [Working around email deliverability issues](./configuring-playbook-matrix-authentication-service.md#working-around-email-deliverability-issues) section for more information. ### Registering users manually for Synapse