From 52fc398332e11234f4782e1fa086e8851d35c520 Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Sun, 3 Nov 2024 23:59:28 +0900 Subject: [PATCH] Update docs/installing.md: playbook tags about starting and restarting services Per comments on https://github.com/spantaleev/matrix-docker-ansible-deploy/issues/3215 it is no longer correct that running tasks with "setup-all" and "install-all" tags would not start or restart services. Signed-off-by: Suguru Hirahara --- docs/installing.md | 7 ++----- 1 file changed, 2 insertions(+), 5 deletions(-) diff --git a/docs/installing.md b/docs/installing.md index ef816aff8..80eea2a3f 100644 --- a/docs/installing.md +++ b/docs/installing.md @@ -15,11 +15,11 @@ The general command syntax is: `ansible-playbook -i inventory/hosts setup.yml -- Here are some playbook tags that you should be familiar with: -- `setup-all` - runs all setup tasks (installation and uninstallation) for all components, but does not start/restart services +- `setup-all` - runs all setup tasks (installation and uninstallation) for all components, and starts/restarts services - `install-all` - like `setup-all`, but skips uninstallation tasks. Useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove components, you'd need to run `setup-all` though, or these components will still remain installed -- `setup-SERVICE` (e.g. `setup-postmoogle`) - runs the setup tasks only for a given role, but does not start/restart services. You can discover these additional tags in each role (`roles/**/tasks/main.yml`). Running per-component setup tasks is **not recommended**, as components sometimes depend on each other and running just the setup tasks for a given component may not be enough. For example, setting up the [mautrix-telegram bridge](configuring-playbook-bridge-mautrix-telegram.md), in addition to the `setup-mautrix-telegram` tag, requires database changes (the `setup-postgres` tag) as well as reverse-proxy changes (the `setup-nginx-proxy` tag). +- `setup-SERVICE` (e.g. `setup-postmoogle`) - runs the setup tasks only for a given role, and starts/restarts services. You can discover these additional tags in each role (`roles/**/tasks/main.yml`). Running per-component setup tasks is **not recommended**, as components sometimes depend on each other and running just the setup tasks for a given component may not be enough. For example, setting up the [mautrix-telegram bridge](configuring-playbook-bridge-mautrix-telegram.md), in addition to the `setup-mautrix-telegram` tag, requires database changes (the `setup-postgres` tag) as well as reverse-proxy changes (the `setup-nginx-proxy` tag). - `install-SERVICE` (e.g. `install-postmoogle`) - like `setup-SERVICE`, but skips uninstallation tasks. See `install-all` above for additional information. @@ -29,9 +29,6 @@ Here are some playbook tags that you should be familiar with: - `ensure-matrix-users-created` - a special tag which ensures that all special users needed by the playbook (for bots, etc.) are created -`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. - - ## 1. Installing Matrix If you **don't** use SSH keys for authentication, but rather a regular password, you may need to add `--ask-pass` to the all Ansible commands