Compare commits

...

4 Commits

Author SHA1 Message Date
Slavi Pantaleev
ba0ef316cc
Merge pull request #3791 from luixxiul/fix
Update docs/registering-users.md: add details about delegation
2024-11-17 21:34:43 +02:00
Aine
7fc8509f04
synapse - update retention purge jobs template 2024-11-17 18:34:22 +02:00
Suguru Hirahara
6e9c143d56
Update docs/registering-users.md: add details about delegation
The change is based on 7e45325338106a09efbdd8db8daba09932bb866e.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-18 00:50:26 +09:00
Suguru Hirahara
7e45325338
Update docs/installing.md: add "Create your user account" section before "Finalize the installation" (#3789)
* Update docs/installing.md: add "Create your user account" section before "Finalize the installation"

docs/registering-users.md has correctly instructed that service delegation should be conducted after creating user accounts to finalize the installation process.

Since it does not really make sense to claim that installation has finished if there is not a user, this commit adds instruction to create a user account before configuring server delegation.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>

* Update docs/installing.md

Co-authored-by: Slavi Pantaleev <slavi@devture.com>

* Update installing.md: remove a whitespace character

---------

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
Co-authored-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
Co-authored-by: Slavi Pantaleev <slavi@devture.com>
2024-11-17 17:42:12 +02:00
3 changed files with 26 additions and 4 deletions

View File

@ -66,9 +66,31 @@ You can now:
ansible-playbook -i inventory/hosts setup.yml --tags=ensure-matrix-users-created,start
```
## Create your user account
*You can skip this step if you have installed a server and imported old data to it.*
As you have configured your brand new server and the client, you need to **create your user account** on your Matrix server.
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 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 `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=YOUR_PASSWORD_HERE 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`
```
For more information, see the documentation for [registering users](registering-users.md).
## Finalize the installation
Now that services are running, you need to **finalize the installation process** by [delegating (redirecting) the server](howto-server-delegation.md) to your base domain (`example.com`).
Now you've configured Matrix services and your user account, you need to **finalize the installation process** by [setting up Matrix delegation (redirection)](howto-server-delegation.md), so that your Matrix server (`matrix.example.com`) can present itself as the base domain (`example.com`) in the Matrix network.
This is required for federation to work! Without a proper configuration, your server will effectively not be part of the Matrix network.
@ -93,7 +115,6 @@ ansible-playbook -i inventory/hosts setup.yml --tags=install-all,start
After finilizing the installation, you can:
- [check if services work](maintenance-checking-services.md)
- or [create your first Matrix user account](registering-users.md)
- or [set up additional services](configuring-playbook.md#other-configuration-options) (bridges to other chat networks, bots, etc.)
- or learn how to [upgrade services when new versions are released](maintenance-upgrading-services.md)
- or learn how to [maintain your server](faq.md#maintenance)

View File

@ -81,8 +81,9 @@ This `register-user` script actually invokes the `mas-cli manage register-user`
## Things to do after registering users
If you've just installed Matrix and created some users, **to finalize the installation process** it's best if you proceed with [Configuring service discovery via .well-known](configuring-well-known.md)
If you've just installed Matrix and created some users, you mostly need to **finalize the installation process** by [setting up Matrix delegation (redirection)](howto-server-delegation.md), so that your Matrix server (`matrix.example.com`) can present itself as the base domain (`example.com`) in the Matrix network.
This is required for federation to work! Without a proper configuration, your server will effectively not be part of the Matrix network.
## Managing users via a Web UI

View File

@ -651,7 +651,7 @@ retention:
# room's policy to these values is done after the policies are retrieved from
# Synapse's database (which is done using the range specified in a purge job's
# configuration).
{% if matrix_synapse_retention_purge_jobs is not none %}
{% if matrix_synapse_retention_purge_jobs | length > 0 %}
purge_jobs:
{% for job in matrix_synapse_retention_purge_jobs %}
- {% if job.longest_max_lifetime is defined %}longest_max_lifetime: {{ job.longest_max_lifetime|to_json }}{% endif %}