From 925ebfbd4bc2302ca282ef2f576a738781a6157a Mon Sep 17 00:00:00 2001 From: Slavi Pantaleev Date: Thu, 21 Nov 2024 16:21:42 +0200 Subject: [PATCH 01/15] Update docs/configuring-playbook-element-call.md Co-authored-by: Suguru Hirahara --- docs/configuring-playbook-element-call.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/configuring-playbook-element-call.md b/docs/configuring-playbook-element-call.md index 6a6b5a496..4754722be 100644 --- a/docs/configuring-playbook-element-call.md +++ b/docs/configuring-playbook-element-call.md @@ -19,9 +19,9 @@ If you'd like to run Element Call on another hostname or path, use the `matrix_e If you've changed the default hostname, **you may need to adjust your DNS** records accordingly to point to the correct server. Ensure that the following DNS names have a public IP/FQDN: -- `call.DOMAIN` -- `sfu.DOMAIN` -- `sfu-jwt.DOMAIN` +- `call.example.com` +- `sfu.example.com` +- `sfu-jwt.example.com` ## Adjusting the playbook configuration From 55da5c3213ce9581654b128d0ff66a7b6a1d38ad Mon Sep 17 00:00:00 2001 From: Slavi Pantaleev Date: Thu, 21 Nov 2024 16:21:55 +0200 Subject: [PATCH 02/15] Update docs/configuring-playbook-element-call.md Co-authored-by: Suguru Hirahara --- docs/configuring-playbook-element-call.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/configuring-playbook-element-call.md b/docs/configuring-playbook-element-call.md index 4754722be..c600b3fb9 100644 --- a/docs/configuring-playbook-element-call.md +++ b/docs/configuring-playbook-element-call.md @@ -36,6 +36,7 @@ keydb_enabled: true matrix_element_call_enabled: true matrix_livekit_server_enabled: true matrix_jwt_service_enabled: true + # Set a secure key for LiveKit authentication matrix_livekit_server_dev_key: 'your-secure-livekit-key' ``` From 25a8cb3b4a3a43f592a894a2170da5d9c164cd34 Mon Sep 17 00:00:00 2001 From: Slavi Pantaleev Date: Thu, 21 Nov 2024 16:22:17 +0200 Subject: [PATCH 03/15] Update docs/configuring-playbook-element-call.md Co-authored-by: Suguru Hirahara --- docs/configuring-playbook-element-call.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/docs/configuring-playbook-element-call.md b/docs/configuring-playbook-element-call.md index c600b3fb9..4ec65d0ec 100644 --- a/docs/configuring-playbook-element-call.md +++ b/docs/configuring-playbook-element-call.md @@ -42,10 +42,8 @@ matrix_livekit_server_dev_key: 'your-secure-livekit-key' ``` ## Installing -After potentially adjusting DNS records and configuring the playbook, run the installation command again: -```yaml -ansible-playbook -i inventory setup.yml -``` + +After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the [installation](installing.md) command: `just install-all` or `just setup-all` ## Usage Once installed, Element Call integrates seamlessly with Matrix clients like Element Web. When the Element Call service is installed, the `/.well-known/matrix/client` file is also updated. A new `org.matrix.msc4143.rtc_foci` section is added to point to your JWT service URL (e.g., `https://sfu-jwt.DOMAIN`). From 32ea60fdc5547d931b0797ce9e04b570b0c71255 Mon Sep 17 00:00:00 2001 From: Slavi Pantaleev Date: Thu, 21 Nov 2024 16:22:44 +0200 Subject: [PATCH 04/15] Update docs/configuring-playbook-element-call.md Co-authored-by: Suguru Hirahara --- docs/configuring-playbook-element-call.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/docs/configuring-playbook-element-call.md b/docs/configuring-playbook-element-call.md index 4ec65d0ec..6ed90320d 100644 --- a/docs/configuring-playbook-element-call.md +++ b/docs/configuring-playbook-element-call.md @@ -46,9 +46,10 @@ matrix_livekit_server_dev_key: 'your-secure-livekit-key' After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the [installation](installing.md) command: `just install-all` or `just setup-all` ## Usage -Once installed, Element Call integrates seamlessly with Matrix clients like Element Web. When the Element Call service is installed, the `/.well-known/matrix/client` file is also updated. A new `org.matrix.msc4143.rtc_foci` section is added to point to your JWT service URL (e.g., `https://sfu-jwt.DOMAIN`). -Additionally, the `/.well-known/element/element.json` file is created to help Element clients discover the Element Call URL (e.g., `https://call.DOMAIN`). +Once installed, Element Call integrates seamlessly with Matrix clients like Element Web. When the Element Call service is installed, the `/.well-known/matrix/client` file is also updated. A new `org.matrix.msc4143.rtc_foci` section is added to point to your JWT service URL (e.g., `https://sfu-jwt.example.com`). + +Additionally, the `/.well-known/element/element.json` file is created to help Element clients discover the Element Call URL (e.g., `https://call.example.com`). ## Required Firewall and Port Forwarding Rules From ccb29beb303a56f3b52ed48d3631859ca5d36eaa Mon Sep 17 00:00:00 2001 From: Slavi Pantaleev Date: Thu, 21 Nov 2024 16:22:56 +0200 Subject: [PATCH 05/15] Update docs/configuring-playbook-jwt-service.md Co-authored-by: Suguru Hirahara --- docs/configuring-playbook-jwt-service.md | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/configuring-playbook-jwt-service.md b/docs/configuring-playbook-jwt-service.md index 7910c0920..f64a86d49 100644 --- a/docs/configuring-playbook-jwt-service.md +++ b/docs/configuring-playbook-jwt-service.md @@ -27,6 +27,7 @@ Add the following configuration to your `inventory/host_vars/matrix.DOMAIN/vars. ```yaml matrix_jwt_service_enabled: true + # Set a secure key for LiveKit authentication matrix_element_call_livekit_dev_key: 'your-secure-livekit-key' ``` From eb048da8a1e374aca5f1dc04c46a3245933b22c4 Mon Sep 17 00:00:00 2001 From: Slavi Pantaleev Date: Thu, 21 Nov 2024 16:23:06 +0200 Subject: [PATCH 06/15] Update docs/configuring-playbook-jwt-service.md Co-authored-by: Suguru Hirahara --- docs/configuring-playbook-jwt-service.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/configuring-playbook-jwt-service.md b/docs/configuring-playbook-jwt-service.md index f64a86d49..664b4d492 100644 --- a/docs/configuring-playbook-jwt-service.md +++ b/docs/configuring-playbook-jwt-service.md @@ -23,7 +23,7 @@ Ensure that the following DNS names have a public IP/FQDN: ## Adjusting the playbook configuration -Add the following configuration to your `inventory/host_vars/matrix.DOMAIN/vars.yml` file: +Add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file: ```yaml matrix_jwt_service_enabled: true From df6ef106d1cf9e062ec38fed60374c4724ad0630 Mon Sep 17 00:00:00 2001 From: Slavi Pantaleev Date: Thu, 21 Nov 2024 16:23:18 +0200 Subject: [PATCH 07/15] Update docs/configuring-playbook-jwt-service.md Co-authored-by: Suguru Hirahara --- docs/configuring-playbook-jwt-service.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/configuring-playbook-jwt-service.md b/docs/configuring-playbook-jwt-service.md index 664b4d492..5b84ffb16 100644 --- a/docs/configuring-playbook-jwt-service.md +++ b/docs/configuring-playbook-jwt-service.md @@ -39,7 +39,8 @@ ansible-playbook -i inventory setup.yml ``` ## Usage -Once installed, a new `org.matrix.msc4143.rtc_foci` section is added to the element web client to point to your JWT service URL (e.g., `https://sfu-jwt.DOMAIN`). + +Once installed, a new `org.matrix.msc4143.rtc_foci` section is added to the element web client to point to your JWT service URL (e.g., `https://sfu-jwt.example.com`). ## Additional Information From ec41c1aba5746e23b2696e6968e8744478d7e889 Mon Sep 17 00:00:00 2001 From: Slavi Pantaleev Date: Thu, 21 Nov 2024 16:23:28 +0200 Subject: [PATCH 08/15] Update docs/configuring-playbook-jwt-service.md Co-authored-by: Suguru Hirahara --- docs/configuring-playbook-jwt-service.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/docs/configuring-playbook-jwt-service.md b/docs/configuring-playbook-jwt-service.md index 5b84ffb16..85f142da5 100644 --- a/docs/configuring-playbook-jwt-service.md +++ b/docs/configuring-playbook-jwt-service.md @@ -33,10 +33,8 @@ matrix_element_call_livekit_dev_key: 'your-secure-livekit-key' ``` ## Installing -After potentially adjusting DNS records and configuring the playbook, run the installation command again: -```yaml -ansible-playbook -i inventory setup.yml -``` + +After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the [installation](installing.md) command: `just install-all` or `just setup-all` ## Usage From 66cc36466c0e72bff5ecc5452ab7d4ebd8244889 Mon Sep 17 00:00:00 2001 From: Slavi Pantaleev Date: Thu, 21 Nov 2024 16:23:36 +0200 Subject: [PATCH 09/15] Update docs/configuring-playbook-livekit-server.md Co-authored-by: Suguru Hirahara --- docs/configuring-playbook-livekit-server.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/docs/configuring-playbook-livekit-server.md b/docs/configuring-playbook-livekit-server.md index 309d9ecf3..5656abc51 100644 --- a/docs/configuring-playbook-livekit-server.md +++ b/docs/configuring-playbook-livekit-server.md @@ -32,10 +32,8 @@ matrix_element_call_livekit_dev_key: 'your-secure-livekit-key' ``` ## Installing -After potentially adjusting DNS records and configuring the playbook, run the installation command again: -```yaml -ansible-playbook -i inventory setup.yml -``` + +After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the [installation](installing.md) command: `just install-all` or `just setup-all` ## Usage Once installed, and in conjunction with Element Call and JWT Service, Livekit will become the WebRTC backend for all Element client calls. From 378392227563f90b664754d283b03fddbedd15f8 Mon Sep 17 00:00:00 2001 From: Slavi Pantaleev Date: Thu, 21 Nov 2024 16:23:47 +0200 Subject: [PATCH 10/15] Update docs/configuring-playbook-livekit-server.md Co-authored-by: Suguru Hirahara --- docs/configuring-playbook-livekit-server.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/configuring-playbook-livekit-server.md b/docs/configuring-playbook-livekit-server.md index 5656abc51..2b533bbca 100644 --- a/docs/configuring-playbook-livekit-server.md +++ b/docs/configuring-playbook-livekit-server.md @@ -27,9 +27,9 @@ Add the following configuration to your `inventory/host_vars/matrix.DOMAIN/vars. ```yaml matrix_livekit_server_enabled: true + # Set a secure key for LiveKit authentication matrix_element_call_livekit_dev_key: 'your-secure-livekit-key' -``` ## Installing From 83bb546c643d3d7a4c9f6271084d221a0de98a1f Mon Sep 17 00:00:00 2001 From: Slavi Pantaleev Date: Thu, 21 Nov 2024 16:23:55 +0200 Subject: [PATCH 11/15] Update docs/configuring-playbook-livekit-server.md Co-authored-by: Suguru Hirahara --- docs/configuring-playbook-livekit-server.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/configuring-playbook-livekit-server.md b/docs/configuring-playbook-livekit-server.md index 2b533bbca..c3abbdc4f 100644 --- a/docs/configuring-playbook-livekit-server.md +++ b/docs/configuring-playbook-livekit-server.md @@ -1,4 +1,4 @@ -# Setting up Livekit (optional) +# Setting up LiveKit (optional) The playbook can install and configure [Livekit](https://github.com/livekit/livekit) for you. From 0f23e36e12a652965552424b5547cdd7e04035d8 Mon Sep 17 00:00:00 2001 From: Slavi Pantaleev Date: Thu, 21 Nov 2024 16:24:05 +0200 Subject: [PATCH 12/15] Update docs/configuring-playbook-livekit-server.md Co-authored-by: Suguru Hirahara --- docs/configuring-playbook-livekit-server.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/configuring-playbook-livekit-server.md b/docs/configuring-playbook-livekit-server.md index c3abbdc4f..7882aae8e 100644 --- a/docs/configuring-playbook-livekit-server.md +++ b/docs/configuring-playbook-livekit-server.md @@ -1,6 +1,6 @@ # Setting up LiveKit (optional) -The playbook can install and configure [Livekit](https://github.com/livekit/livekit) for you. +The playbook can install and configure [LiveKit](https://github.com/livekit/livekit) for you. LiveKit is an open source project that provides scalable, multi-user conferencing based on WebRTC. It's designed to provide everything you need to build real-time video audio data capabilities in your applications. From 164be875b0e3305191135784e1183b94143ff7c1 Mon Sep 17 00:00:00 2001 From: Slavi Pantaleev Date: Thu, 21 Nov 2024 16:24:15 +0200 Subject: [PATCH 13/15] Update docs/configuring-playbook-livekit-server.md Co-authored-by: Suguru Hirahara --- docs/configuring-playbook-livekit-server.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/configuring-playbook-livekit-server.md b/docs/configuring-playbook-livekit-server.md index 7882aae8e..fa5264954 100644 --- a/docs/configuring-playbook-livekit-server.md +++ b/docs/configuring-playbook-livekit-server.md @@ -8,7 +8,7 @@ See the project's [documentation](https://github.com/livekit/livekit) to learn m ## Decide on a domain and path -By default, Livekit is configured to be served on the Matrix domain (`sfu.DOMAIN`, controlled by the `matrix_livekit_server_hostname` variable). +By default, LiveKit is configured to be served on the Matrix domain (`sfu.example.com`, controlled by the `matrix_livekit_server_hostname` variable). This makes it easy to set it up, **without** having to adjust your DNS records manually. From c321ca160ecbeec8f3ed9a96802aa436510779f8 Mon Sep 17 00:00:00 2001 From: Slavi Pantaleev Date: Thu, 21 Nov 2024 16:24:26 +0200 Subject: [PATCH 14/15] Update docs/configuring-playbook-livekit-server.md Co-authored-by: Suguru Hirahara --- docs/configuring-playbook-livekit-server.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/configuring-playbook-livekit-server.md b/docs/configuring-playbook-livekit-server.md index fa5264954..561d8f7fe 100644 --- a/docs/configuring-playbook-livekit-server.md +++ b/docs/configuring-playbook-livekit-server.md @@ -19,7 +19,7 @@ If you'd like to run Livekit on another hostname or path, use the `matrix_liveki If you've changed the default hostname, **you may need to adjust your DNS** records accordingly to point to the correct server. Ensure that the following DNS names have a public IP/FQDN: -- `sfu.DOMAIN` +- `sfu.example.com` ## Adjusting the playbook configuration From c07b0939022dcbc8667d37d987ca7a5137bf7cea Mon Sep 17 00:00:00 2001 From: Slavi Pantaleev Date: Thu, 21 Nov 2024 16:24:34 +0200 Subject: [PATCH 15/15] Update docs/configuring-playbook-livekit-server.md Co-authored-by: Suguru Hirahara --- docs/configuring-playbook-livekit-server.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/configuring-playbook-livekit-server.md b/docs/configuring-playbook-livekit-server.md index 561d8f7fe..34008ffa3 100644 --- a/docs/configuring-playbook-livekit-server.md +++ b/docs/configuring-playbook-livekit-server.md @@ -23,7 +23,7 @@ Ensure that the following DNS names have a public IP/FQDN: ## Adjusting the playbook configuration -Add the following configuration to your `inventory/host_vars/matrix.DOMAIN/vars.yml` file: +Add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file: ```yaml matrix_livekit_server_enabled: true