From 514ae1b60dcba72911b460e24f9738be15359b52 Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Fri, 17 Jan 2025 02:38:23 +0900 Subject: [PATCH] Update docs/configuring-playbook-turn.md: add a section for description about installing Signed-off-by: Suguru Hirahara --- docs/configuring-playbook-turn.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/docs/configuring-playbook-turn.md b/docs/configuring-playbook-turn.md index f71b84e69..30e534ff3 100644 --- a/docs/configuring-playbook-turn.md +++ b/docs/configuring-playbook-turn.md @@ -73,3 +73,16 @@ You can put multiple host/port combinations if you like. ## Further variables and configuration options To see all the available configuration options, check roles/custom/matrix-coturn/defaults/main.yml + +## Installing + +After configuring the playbook, run it with [playbook tags](playbook-tags.md) as below: + + +```sh +ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start +``` + +The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all` + +`just install-all` is useful for maintaining your setup quickly ([2x-5x faster](../CHANGELOG.md#2x-5x-performance-improvements-in-playbook-runtime) than `just setup-all`) when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. Note these shortcuts run the `ensure-matrix-users-created` tag too.