From 0a33e69e56e108c146e4f9a38a6ae842665d16f3 Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Mon, 17 Feb 2025 23:02:26 +0900 Subject: [PATCH] Update docs/configuring-playbook-jitsi.md: edit the section for adjusting the playbook configuration - Add the comment blocks around the variable - Add links to the role's document Signed-off-by: Suguru Hirahara --- docs/configuring-playbook-jitsi.md | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/docs/configuring-playbook-jitsi.md b/docs/configuring-playbook-jitsi.md index 3b2adf9a1..258a14143 100644 --- a/docs/configuring-playbook-jitsi.md +++ b/docs/configuring-playbook-jitsi.md @@ -41,9 +41,25 @@ When setting, replace `example.com` with your own. To enable Jitsi, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file: ```yaml +######################################################################## +# # +# jitsi # +# # +######################################################################## + jitsi_enabled: true + +######################################################################## +# # +# /jitsi # +# # +######################################################################## ``` +As the most of the necessary settings for the role have been taken care of by the playbook, you can enable Jitsi on your Matrix server with this minimum configuration. + +See the role's document for details about configuring Jitsi per your preference (such as [authentication and guests mode](https://github.com/mother-of-all-self-hosting/ansible-role-jitsi/blob/main/docs/configuring-jitsi.md#configure-jitsi-authentication-and-guests-mode-optional) and [the environment variable for running Jitsi in a LAN](https://github.com/mother-of-all-self-hosting/ansible-role-jitsi/blob/main/docs/configuring-jitsi.md#configure-jvb_advertise_ips-for-running-behind-nat-or-on-a-lan-environment-optional)). + ### Adjusting the Jitsi URL (optional) By tweaking the `jitsi_hostname` variable, you can easily make the service available at a **different hostname** than the default one.