Add comments to ensure-matrix-users-created

This change intends to explain how ensure-matrix-users-created and ensure-users-created are expected to work by default.

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
This commit is contained in:
Suguru Hirahara 2025-03-15 16:43:14 +09:00 committed by Slavi Pantaleev
parent a0573e5855
commit 43514542bd
2 changed files with 3 additions and 1 deletions

View File

@ -27,7 +27,7 @@ Here are some playbook tags that you should be familiar with:
- `stop` — stops all systemd services
- `ensure-matrix-users-created` or its alias `ensure-users-created` — a special tag which ensures that all special users needed by the playbook (for bots, etc.) are created
- `ensure-matrix-users-created` or its alias `ensure-users-created` — a special tag which ensures that all special users needed by the playbook (for bots, etc.) are created. See the variable `matrix_user_creator_users_auto` on [`group_vars/matrix_servers`](../group_vars/matrix_servers) for actual values of users which running this tag can create by default.
**Notes**:
- `setup-*` tags and `install-*` tags **do not start services** automatically, because you may wish to do things before starting services, such as importing a database dump, restoring data from another server, etc.

View File

@ -9,6 +9,8 @@
# This role intentionally doesn't do work on a `setup-all` tag.
# If it did, the initial installation (`--tags=setup-all`) would also potentially polute the database with data,
# which would make importing a database dump problematic.
#
# See the variable "matrix_user_creator_users_auto" on group_vars/matrix_servers for actual values of users which running these tags can create with this role by default.
- ensure-matrix-users-created
- ensure-users-created
block: