From 24ad78fae30e9ffb38f687614a6b88b7709007e0 Mon Sep 17 00:00:00 2001
From: Suguru Hirahara <acioustick@noreply.codeberg.org>
Date: Sat, 30 Nov 2024 14:26:12 +0900
Subject: [PATCH] Update docs/configuring-playbook-synapse-admin.md: add the
 playbook command and just recipes

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
---
 docs/configuring-playbook-synapse-admin.md | 9 +++++++++
 1 file changed, 9 insertions(+)

diff --git a/docs/configuring-playbook-synapse-admin.md b/docs/configuring-playbook-synapse-admin.md
index d0ce29469..a6b52fa9c 100644
--- a/docs/configuring-playbook-synapse-admin.md
+++ b/docs/configuring-playbook-synapse-admin.md
@@ -50,6 +50,15 @@ If you've decided to use the default hostname, you won't need to do any extra DN
 
 After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below:
 
+<!-- NOTE: let this conservative command run (instead of install-all) to make it clear that failure of the command means something is clearly broken. -->
+```sh
+ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
+```
+
+The shortcut commands with `just` program are also available: `just run-tags install-all,start` or `just run-tags setup-all,start`
+
+`just run-tags install-all,start` is useful for maintaining your setup quickly when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just run-tags setup-all,start`, or these components will still remain installed. For more information about `just` shortcuts, take a look at this page: [Running `just` commands](just.md)
+
 ## Usage
 
 After installation, Synapse Admin will be accessible at: `https://matrix.example.com/synapse-admin/`