From 43514542bdabefd5bfdc52c8cfb23227b3145c5d Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Sat, 15 Mar 2025 16:43:14 +0900 Subject: [PATCH] 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 --- docs/playbook-tags.md | 2 +- roles/custom/matrix-user-creator/tasks/main.yml | 2 ++ 2 files changed, 3 insertions(+), 1 deletion(-) diff --git a/docs/playbook-tags.md b/docs/playbook-tags.md index 48e61f73c..e7b9682c0 100644 --- a/docs/playbook-tags.md +++ b/docs/playbook-tags.md @@ -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. diff --git a/roles/custom/matrix-user-creator/tasks/main.yml b/roles/custom/matrix-user-creator/tasks/main.yml index 6a1a0b20c..8f166bb1c 100644 --- a/roles/custom/matrix-user-creator/tasks/main.yml +++ b/roles/custom/matrix-user-creator/tasks/main.yml @@ -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: