From b2dc1fd105462cac005b07365f40269201319d9f Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Sun, 12 Jan 2025 20:29:18 +0900 Subject: [PATCH] Update docs/configuring-playbook-jitsi.md: replace the description about running behind NAT or on a LAN environment with the official one Our original description was unorganized and difficult to understand, so this commit simply replaces it with the official documentation provided by Jitsi, which is clear and straightforward. See: https://github.com/jitsi/handbook/blob/630a6817c2e5e5d5d2843ed7b6cea8afc4fe880f/docs/devops-guide/docker.md Signed-off-by: Suguru Hirahara --- docs/configuring-playbook-jitsi.md | 14 +++++++++----- 1 file changed, 9 insertions(+), 5 deletions(-) diff --git a/docs/configuring-playbook-jitsi.md b/docs/configuring-playbook-jitsi.md index 35415f7a3..4a6120585 100644 --- a/docs/configuring-playbook-jitsi.md +++ b/docs/configuring-playbook-jitsi.md @@ -108,19 +108,23 @@ jitsi_ldap_start_tls: false For more information refer to the [docker-jitsi-meet](https://github.com/jitsi/docker-jitsi-meet#authentication-using-ldap) and the [saslauthd `LDAP_SASLAUTHD`](https://github.com/winlibs/cyrus-sasl/blob/master/saslauthd/LDAP_SASLAUTHD) documentation. -### Making your Jitsi server work on a LAN (optional) +### Running behind NAT or on a LAN environment (optional) -By default the Jitsi Meet instance does not work with a client in LAN (Local Area Network), even if others are connected from WAN. There are no video and audio. In the case of WAN to WAN everything is ok. +When running Jitsi in a LAN environment, or on the public Internet via NAT, the `JVB_ADVERTISE_IPS` enviornment variable should be set. -The reason is the Jitsi VideoBridge git to LAN client the IP address of the docker image instead of the host. The [documentation](https://jitsi.github.io/handbook/docs/devops-guide/devops-guide-docker/#running-behind-nat-or-on-a-lan-environment) of Jitsi in docker suggest to add `JVB_ADVERTISE_IPS` in enviornment variable to make it work. +This variable allows to control which IP addresses the JVB will advertise for WebRTC media traffic. It is necessary to set it regardless of the use of a reverse proxy, since it's the IP address that will receive the media (audio / video) and not HTTP traffic, hence it's oblivious to the reverse proxy. -To enable it, add the following configuration to your `vars.yml` file: +If your users are coming in over the Internet (and not over LAN), this will likely be your public IP address. If this is not set up correctly, calls will crash when more than two users join a meeting. + +To set the variable, add the following configuration to your `vars.yml` file. Make sure to replace `LOCAL_IP_ADDRESS_OF_THE_HOST_HERE` with a proper value. ```yaml jitsi_jvb_container_extra_arguments: - - '--env "JVB_ADVERTISE_IPS="' + - '--env "JVB_ADVERTISE_IPS=LOCAL_IP_ADDRESS_OF_THE_HOST_HERE"' ``` +Check [the official documentation](https://jitsi.github.io/handbook/docs/devops-guide/devops-guide-docker/#running-behind-nat-or-on-a-lan-environment) for more details about it. + ### Specify a Max number of participants on a Jitsi conference (optional) The playbook allows a user to set a max number of participants allowed to join a Jitsi conference. By default the number is not limited.