From 5642755273614e1bdd1f8cf89750874c5ecf3fd7 Mon Sep 17 00:00:00 2001 From: Slavi Pantaleev Date: Sat, 23 Nov 2024 16:40:50 +0200 Subject: [PATCH] Rework LiveKit JWT Service role --- docs/configuring-playbook-element-call.md | 9 +- docs/configuring-playbook-jwt-service.md | 21 ++-- docs/configuring-playbook.md | 2 +- group_vars/matrix_servers | 82 +++++++----- .../templates/config.json.j2 | 4 +- .../matrix-jwt-service/defaults/main.yml | 117 ------------------ .../matrix-jwt-service/tasks/install.yml | 46 ------- .../matrix-jwt-service/tasks/uninstall.yml | 22 ---- .../tasks/validate_config.yml | 12 -- .../matrix-jwt-service/templates/env.j2 | 4 - .../matrix-jwt-service/templates/labels.j2 | 46 ------- .../defaults/main.yml | 81 ++++++++++++ .../tasks/install.yml | 69 +++++++++++ .../tasks/main.yml | 13 +- .../tasks/uninstall.yml | 25 ++++ .../tasks/validate_config.yml | 13 ++ .../templates/env.j2 | 7 ++ .../templates/labels.j2 | 48 +++++++ .../matrix-livekit-jwt-service.service.j2} | 38 +++--- .../matrix-livekit-jwt-service/vars/main.yml | 3 + .../matrix-livekit-server/defaults/main.yml | 2 +- .../matrix-livekit-server/tasks/install.yml | 38 +++++- .../systemd/livekit-server.service.j2 | 6 +- .../matrix-livekit-server/vars/main.yml | 2 + setup.yml | 2 +- 25 files changed, 378 insertions(+), 334 deletions(-) delete mode 100644 roles/custom/matrix-jwt-service/defaults/main.yml delete mode 100644 roles/custom/matrix-jwt-service/tasks/install.yml delete mode 100644 roles/custom/matrix-jwt-service/tasks/uninstall.yml delete mode 100644 roles/custom/matrix-jwt-service/tasks/validate_config.yml delete mode 100644 roles/custom/matrix-jwt-service/templates/env.j2 delete mode 100644 roles/custom/matrix-jwt-service/templates/labels.j2 create mode 100644 roles/custom/matrix-livekit-jwt-service/defaults/main.yml create mode 100644 roles/custom/matrix-livekit-jwt-service/tasks/install.yml rename roles/custom/{matrix-jwt-service => matrix-livekit-jwt-service}/tasks/main.yml (57%) create mode 100644 roles/custom/matrix-livekit-jwt-service/tasks/uninstall.yml create mode 100644 roles/custom/matrix-livekit-jwt-service/tasks/validate_config.yml create mode 100644 roles/custom/matrix-livekit-jwt-service/templates/env.j2 create mode 100644 roles/custom/matrix-livekit-jwt-service/templates/labels.j2 rename roles/custom/{matrix-jwt-service/templates/systemd/matrix-jwt-service.service.j2 => matrix-livekit-jwt-service/templates/systemd/matrix-livekit-jwt-service.service.j2} (52%) create mode 100644 roles/custom/matrix-livekit-jwt-service/vars/main.yml diff --git a/docs/configuring-playbook-element-call.md b/docs/configuring-playbook-element-call.md index 663a07038..d9f2e3a44 100644 --- a/docs/configuring-playbook-element-call.md +++ b/docs/configuring-playbook-element-call.md @@ -25,16 +25,13 @@ Ensure that the following DNS names have a public IP/FQDN: ## Adjusting the playbook configuration -NOTE: Element call is dependent on two other services for it to function as intended. In orter to utilise Element Call you need to also enable the [JWT Service](configuring-playbook-jwt-service.md) and [Livekit Server](configuring-playbook-livekit-server.md). +NOTE: Enabling Element Call will automatically enable the [LiveKit JWT Service](configuring-playbook-livekit-jwt-service.md) and Livekit Server services. Add the following configuration to your `inventory/host_vars/matrix.DOMAIN/vars.yml` file: ```yaml matrix_element_call_enabled: true - -# Set a secure key for LiveKit authentication -livekit_server_config_keys_devkey: 'your-secure-livekit-key' ``` ## Installing @@ -43,7 +40,7 @@ After configuring the playbook and potentially [adjusting your DNS records](#adj ## 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.example.com`). +Once installed, Element Call integrates seamlessly with Matrix clients like [Element Web](configuring-playbook-client-element-web.md). 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 LiveKit JWT service URL (e.g., `https://matrix.example.com/lk-jwt-service`). 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`). @@ -53,7 +50,7 @@ To ensure the services function correctly, the following firewall rules and port LiveKit: - • Forward UDP ports 50100:50200 to the Docker instance running LiveKit. + • Forward UDP ports 50100:50120 to the Docker instance running LiveKit. • Forward TCP port 7881 to the Docker instance running LiveKit. Element Call: diff --git a/docs/configuring-playbook-jwt-service.md b/docs/configuring-playbook-jwt-service.md index 85f142da5..b8c06a0cc 100644 --- a/docs/configuring-playbook-jwt-service.md +++ b/docs/configuring-playbook-jwt-service.md @@ -1,6 +1,6 @@ # Setting up JWT Service (optional) -The playbook can install and configure [JWT Service](https://github.com/element-hq/lk-jwt-service) for you. +The playbook can install and configure [LiveKit JWT Service](https://github.com/element-hq/lk-jwt-service) for you. LK-JWT-Service is currently used for a single reason: generate JWT tokens with a given identity for a given room, so that users can use them to authenticate against LiveKit SFU. @@ -8,28 +8,23 @@ See the project's [documentation](https://github.com/element-hq/lk-jwt-service/) ## Decide on a domain and path -By default, JWT Service is configured to be served on the Matrix domain (`sfu-jwt.DOMAIN`, controlled by the `matrix_jwt-service_hostname` variable). +By default, JWT Service is configured to be served: + +- on the Matrix domain (`matrix.example.com`), configurable via `matrix_livekit_jwt_service_hostname` +- under a `/lk-jwt-service` path prefix, configurable via `matrix_livekit_jwt_service_path_prefix` This makes it easy to set it up, **without** having to adjust your DNS records manually. -If you'd like to run JWT Service on another hostname or path, use the `matrix_jwt-service_hostname` variable. - ## Adjusting DNS records 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-jwt.DOMAIN` - ## Adjusting the playbook configuration Add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file: ```yaml -matrix_jwt_service_enabled: true - -# Set a secure key for LiveKit authentication -matrix_element_call_livekit_dev_key: 'your-secure-livekit-key' +matrix_livekit_jwt_service_enabled: true ``` ## Installing @@ -38,8 +33,8 @@ After configuring the playbook and potentially [adjusting your DNS records](#adj ## 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.example.com`). +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://matrix.example.com/lk-jwt-service`). ## Additional Information -Refer to the JWT-Service documentation for more details on configuring and using JWT Service. \ No newline at end of file +Refer to the LiveKit JWT-Service documentation for more details on configuring and using JWT Service. diff --git a/docs/configuring-playbook.md b/docs/configuring-playbook.md index 632f09568..72eef2fb0 100644 --- a/docs/configuring-playbook.md +++ b/docs/configuring-playbook.md @@ -214,7 +214,7 @@ Various services that don't fit any other categories. - [Setting up the Element Call server](configuring-playbook-element-call.md) (optional) -- [Setting up the JWT Service](configuring-playbook-jwt-service.md) (optional) +- [Setting up the LiveKit JWT Service](configuring-playbook-livekit-jwt-service.md) (optional) - [Setting up the Livekit server](configuring-playbook-livekit-server.md) (optional) diff --git a/group_vars/matrix_servers b/group_vars/matrix_servers index 35009746a..fd6279e89 100755 --- a/group_vars/matrix_servers +++ b/group_vars/matrix_servers @@ -442,7 +442,7 @@ devture_systemd_service_manager_services_list_auto: | + ([{'name': 'matrix-element-call.service', 'priority': 4000, 'groups': ['matrix', 'element-call']}] if matrix_element_call_enabled else []) + - ([{'name': 'matrix-jwt-service.service', 'priority': 3000, 'groups': ['matrix', 'jwt-service']}] if matrix_jwt_service_enabled else []) + ([{'name': 'matrix-livekit-jwt-service.service', 'priority': 3500, 'groups': ['matrix', 'livekit-jwt-service']}] if matrix_livekit_jwt_service_enabled else []) + ([{'name': (livekit_server_identifier + '.service'), 'priority': 3000, 'groups': ['matrix', 'livekit-server']}] if livekit_server_enabled else []) + @@ -5959,7 +5959,7 @@ matrix_static_files_file_matrix_client_property_org_matrix_msc4143_rtc_foci_enab matrix_static_files_file_matrix_client_property_org_matrix_msc4143_rtc_foci_auto: |- {{ ( - [{'type': 'livekit', 'livekit_service_url': matrix_jwt_service_url}] if matrix_jwt_service_enabled else [] + [{'type': 'livekit', 'livekit_service_url': matrix_livekit_jwt_service_public_url}] if matrix_livekit_jwt_service_enabled else [] ) }} @@ -6138,45 +6138,61 @@ livekit_server_container_labels_traefik_docker_network: "{{ matrix_playbook_reve livekit_server_container_labels_traefik_entrypoints: "{{ traefik_entrypoint_primary }}" livekit_server_container_labels_traefik_tls_certResolver: "{{ traefik_certResolver_primary }}" +livekit_server_config_keys_auto: |- + {{ + {} + | combine( + {matrix_livekit_jwt_service_environment_variable_livekit_key: matrix_livekit_jwt_service_environment_variable_livekit_secret} + if matrix_livekit_jwt_service_enabled else {} + ) + }} + ######################################################################## # # # /livekit-server # # # ######################################################################## -######################################################################## -# # -# matrix-jwt-service # -# # -######################################################################## - -matrix_jwt_service_enabled: "{{ matrix_element_call_enabled }}" - -matrix_jwt_service_version: "latest-ci" # Default version; can be overridden in host_vars -matrix_jwt_service_scheme: "https" # Scheme for Element Call (e.g., https) -matrix_jwt_service_hostname: "sfu-jwt.{{ matrix_domain }}" # Default hostname; should be overridden in host_vars if different -matrix_jwt_service_path_prefix: "/" # Path prefix for Element Call -matrix_jwt_service_base_path: "{{ matrix_base_data_path }}/matrix-jwt-service" # Base path for storing Element Call-related files -matrix_jwt_service_container_image: "ghcr.io/element-hq/lk-jwt-service:{{ matrix_jwt_service_version }}" -matrix_jwt_service_container_image_name_prefix: ghcr.io/ -matrix_jwt_service_container_image_registry_prefix: ghcr.io/ -matrix_jwt_service_container_image_force_pull: true - -# Docker network configuration for JWT Service -matrix_jwt_service_container_network: "{{ matrix_addons_container_network }}" -matrix_jwt_service_container_additional_networks: "{{ [matrix_playbook_reverse_proxyable_services_additional_network] if (matrix_jwt_service_container_labels_traefik_enabled and matrix_playbook_reverse_proxyable_services_additional_network) else [] }}" - -# Traefik Configuration for JWT Service -matrix_jwt_service_container_labels_traefik_enabled: "{{ matrix_playbook_reverse_proxy_type in ['playbook-managed-traefik', 'other-traefik-container'] }}" -matrix_jwt_service_container_labels_traefik_docker_network: "{{ matrix_playbook_reverse_proxyable_services_additional_network }}" -matrix_jwt_service_container_labels_traefik_entrypoints: "{{ traefik_entrypoint_primary }}" -matrix_jwt_service_container_labels_traefik_tls_certResolver: "{{ traefik_certResolver_primary }}" - -# JWT Service Configuration -matrix_jwt_service_url: "https://sfu-jwt.{{ matrix_domain }}" # Default JWT service URL; adjust as needed ######################################################################## # # -# /matrix-jwt-service # +# matrix-livekit-jwt-service # +# # +######################################################################## + +matrix_livekit_jwt_service_enabled: "{{ matrix_element_call_enabled and livekit_server_enabled }}" + +matrix_livekit_jwt_service_scheme: "{{ 'https' if matrix_playbook_ssl_enabled else 'http' }}" + +matrix_livekit_jwt_service_hostname: "{{ matrix_server_fqn_matrix }}" +matrix_livekit_jwt_service_path_prefix: "/lk-jwt-service" + +matrix_livekit_jwt_service_container_image_self_build: "{{ matrix_architecture not in ['amd64', 'arm64'] }}" + +matrix_livekit_jwt_service_container_network: "{{ matrix_addons_container_network }}" + +matrix_livekit_jwt_service_container_additional_networks_auto: | + {{ + ( + ([matrix_playbook_reverse_proxyable_services_additional_network] if (matrix_livekit_jwt_service_container_labels_traefik_enabled and matrix_playbook_reverse_proxyable_services_additional_network) else []) + + + ([livekit_server_container_network] if livekit_server_enabled and (matrix_livekit_jwt_service_environment_variable_livekit_url == livekit_server_websocket_container_url and livekit_server_container_network != matrix_livekit_jwt_service_container_network) else []) + ) | unique + }} + +matrix_livekit_jwt_service_container_labels_traefik_enabled: "{{ matrix_playbook_reverse_proxy_type in ['playbook-managed-traefik', 'other-traefik-container'] }}" +matrix_livekit_jwt_service_container_labels_traefik_docker_network: "{{ matrix_playbook_reverse_proxyable_services_additional_network }}" +matrix_livekit_jwt_service_container_labels_traefik_entrypoints: "{{ traefik_entrypoint_primary }}" +matrix_livekit_jwt_service_container_labels_traefik_tls_certResolver: "{{ traefik_certResolver_primary }}" + +matrix_livekit_jwt_service_environment_variable_livekit_url: "{{ livekit_server_websocket_container_url }}" + +matrix_livekit_jwt_service_environment_variable_livekit_key: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'lk.key', rounds=655555) | to_uuid }}" + +matrix_livekit_jwt_service_environment_variable_livekit_secret: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'lk.secret', rounds=655555) | to_uuid }}" + +######################################################################## +# # +# /matrix-livekit-jwt-service # # # ######################################################################## diff --git a/roles/custom/matrix-element-call/templates/config.json.j2 b/roles/custom/matrix-element-call/templates/config.json.j2 index e10fc4f61..4ad4e2b51 100644 --- a/roles/custom/matrix-element-call/templates/config.json.j2 +++ b/roles/custom/matrix-element-call/templates/config.json.j2 @@ -6,6 +6,6 @@ } }, "livekit": { - "livekit_service_url": "{{ matrix_jwt_service_url }}" + "livekit_service_url": "{{ matrix_livekit_jwt_service_public_url }}" } -} \ No newline at end of file +} diff --git a/roles/custom/matrix-jwt-service/defaults/main.yml b/roles/custom/matrix-jwt-service/defaults/main.yml deleted file mode 100644 index ee95afefd..000000000 --- a/roles/custom/matrix-jwt-service/defaults/main.yml +++ /dev/null @@ -1,117 +0,0 @@ ---- -# Enable or disable matrix-element-call deployment -matrix_jwt_service_enabled: false - -# Base path configuration -matrix_jwt_service_base_path: "{{ matrix_base_data_path }}/jwt-service" - -# Docker network configuration -matrix_jwt_service_container_network: '' -matrix_jwt_service_container_http_host_bind_port: '8881' -matrix_jwt_service_container_additional_networks: [] # No additional networks by default - -# Docker images -matrix_jwt_service_image: "ghcr.io/element-hq/lk-jwt-service:latest-ci" - -# Ports -matrix_jwt_service_port: "8881" - -# jwt configuration -matrix_jwt_service_hostname: "sfu-jwt.{{ matrix_domain }}" -matrix_jwt_service_url: "https://sfu-jwt.{{ matrix_domain }}" - -# Traefik Configuration for JWT Service -matrix_jwt_service_container_labels_traefik_enabled: true -matrix_jwt_service_container_labels_traefik_docker_network: "{{ matrix_jwt_service_container_network }}" -matrix_jwt_service_container_labels_traefik_hostname: "{{ matrix_jwt_service_hostname }}" -# The path prefix must either be `/` or not end with a slash (e.g. `/element`). -matrix_jwt_service_container_labels_traefik_path_prefix: "{{ matrix_jwt_service_path_prefix }}" -matrix_jwt_service_container_labels_traefik_rule: "Host(`{{ matrix_jwt_service_container_labels_traefik_hostname }}`){% if matrix_jwt_service_container_labels_traefik_path_prefix != '/' %} && PathPrefix(`{{ matrix_jwt_service_container_labels_traefik_path_prefix }}`){% endif %}" -matrix_jwt_service_container_labels_traefik_priority: 0 -matrix_jwt_service_container_labels_traefik_entrypoints: web-secure -matrix_jwt_service_container_labels_traefik_tls: "{{ matrix_jwt_service_container_labels_traefik_entrypoints != 'web' }}" -matrix_jwt_service_container_labels_traefik_tls_certResolver: default # noqa var-naming - -# Controls which additional headers to attach to all HTTP responses. -# To add your own headers, use `matrix_jwt_service_container_labels_traefik_additional_response_headers_custom` -matrix_jwt_service_container_labels_traefik_additional_response_headers: "{{ matrix_jwt_service_container_labels_traefik_additional_response_headers_auto | combine(matrix_jwt_service_container_labels_traefik_additional_response_headers_custom) }}" -matrix_jwt_service_container_labels_traefik_additional_response_headers_auto: | - {{ - {} - | combine ({'X-XSS-Protection': matrix_jwt_service_http_header_xss_protection} if matrix_jwt_service_http_header_xss_protection else {}) - | combine ({'X-Frame-Options': matrix_jwt_service_http_header_frame_options} if matrix_jwt_service_http_header_frame_options else {}) - | combine ({'X-Content-Type-Options': matrix_jwt_service_http_header_content_type_options} if matrix_jwt_service_http_header_content_type_options else {}) - | combine ({'Content-Security-Policy': matrix_jwt_service_http_header_content_security_policy} if matrix_jwt_service_http_header_content_security_policy else {}) - | combine ({'Permission-Policy': matrix_jwt_service_http_header_content_permission_policy} if matrix_jwt_service_http_header_content_permission_policy else {}) - | combine ({'Strict-Transport-Security': matrix_jwt_service_http_header_strict_transport_security} if matrix_jwt_service_http_header_strict_transport_security and matrix_jwt_service_container_labels_traefik_tls else {}) - }} -matrix_jwt_service_container_labels_traefik_additional_response_headers_custom: {} - -# matrix_client_element_container_labels_additional_labels contains a multiline string with additional labels to add to the container label file. -# See `../templates/labels.j2` for details. -# -# Example: -# matrix_client_element_container_labels_additional_labels: | -# my.label=1 -# another.label="here" -matrix_jwt_service_container_labels_additional_labels: '' - -# A list of extra arguments to pass to the container -matrix_jwt_service_container_extra_arguments: [] - -# Additional environment variables for the container -matrix_jwt_service_environment_variables_additional: {} - -# List of systemd services that matrix-element-call.service depends on -matrix_jwt_service_systemd_required_services_list: "{{ [devture_systemd_docker_base_docker_service_name] if devture_systemd_docker_base_docker_service_name else [] }}" - -# Specifies the value of the `X-XSS-Protection` header -# Stops pages from loading when they detect reflected cross-site scripting (XSS) attacks. -# -# Learn more about it is here: -# - https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-XSS-Protection -# - https://portswigger.net/web-security/cross-site-scripting/reflected -matrix_jwt_service_http_header_xss_protection: '' - -# Specifies the value of the `X-Frame-Options` header which controls whether framing can happen. -# See: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Frame-Options -matrix_jwt_service_http_header_frame_options: '' - -# Specifies the value of the `X-Content-Type-Options` header. -# See: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/X-Content-Type-Options -matrix_jwt_service_http_header_content_type_options: '' - -# Specifies the value of the `Content-Security-Policy` header. -# See: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Content-Security-Policy -matrix_jwt_service_http_header_content_security_policy: '' - -# Specifies the value of the `Permission-Policy` header. -# See: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Permission-Policy -matrix_jwt_service_http_header_content_permission_policy: '' - -# Specifies the value of the `Strict-Transport-Security` header. -# See: https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Strict-Transport-Security -matrix_jwt_service_http_header_strict_transport_security: '' - -# Controls whether to send a "Permissions-Policy interest-cohort=();" header along with all responses -# -# Learn more about what it is here: -# - https://www.eff.org/deeplinks/2021/03/googles-floc-terrible-idea -# - https://paramdeo.com/blog/opting-your-website-out-of-googles-floc-network -# - https://amifloced.org/ -# -# Of course, a better solution is to just stop using browsers (like Chrome), which participate in such tracking practices. -# See: `matrix_jwt_service_content_permission_policy` -matrix_jwt_service_floc_optout_enabled: false - -# Controls if HSTS preloading is enabled -# -# In its strongest and recommended form, the [HSTS policy](https://www.chromium.org/hsts) includes all subdomains, and -# indicates a willingness to be "preloaded" into browsers: -# `Strict-Transport-Security: max-age=31536000; includeSubDomains; preload` -# For more information visit: -# - https://en.wikipedia.org/wiki/HTTP_Strict_Transport_Security -# - https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Strict-Transport-Security -# - https://hstspreload.org/#opt-in -# See: `matrix_jwt_service_http_header_strict_transport_security` -matrix_jwt_service_hsts_preload_enabled: true \ No newline at end of file diff --git a/roles/custom/matrix-jwt-service/tasks/install.yml b/roles/custom/matrix-jwt-service/tasks/install.yml deleted file mode 100644 index 9a51bdfd3..000000000 --- a/roles/custom/matrix-jwt-service/tasks/install.yml +++ /dev/null @@ -1,46 +0,0 @@ ---- -# roles/custom/matrix-jwt-service/tasks/install.yml - -# Ensure Required Directories Exist -- name: Ensure matrix-jwt-service paths exist - ansible.builtin.file: - path: "{{ item.path }}" - state: directory - mode: 0750 - owner: "{{ matrix_user_username }}" - group: "{{ matrix_user_groupname }}" - with_items: - - path: "{{ matrix_jwt_service_base_path }}" - -- name: Ensure matrix-jwt-service environment file is in place - ansible.builtin.template: - src: "{{ role_path }}/templates/env.j2" - dest: "{{ matrix_jwt_service_base_path }}/env" - mode: 0640 - owner: "{{ matrix_user_username }}" - group: "{{ matrix_user_groupname }}" - -- name: Ensure JWT Service labels file is in place - ansible.builtin.template: - src: "{{ role_path }}/templates/labels.j2" - dest: "{{ matrix_jwt_service_base_path }}/labels" - mode: 0640 - owner: "{{ matrix_user_username }}" - group: "{{ matrix_user_groupname }}" - -# Ensure Docker Images are Pulled -- name: Ensure jwt-service Docker image is pulled - community.docker.docker_image: - name: "{{ matrix_jwt_service_image }}" - source: pull - register: jwt_image_result - retries: 3 - delay: 10 - until: jwt_image_result is not failed - -# Systemd Services for JWT Service -- name: Ensure jwt-service systemd service is installed - ansible.builtin.template: - src: "{{ role_path }}/templates/systemd/matrix-jwt-service.service.j2" - dest: "{{ devture_systemd_docker_base_systemd_path }}/matrix-jwt-service.service" - mode: 0644 \ No newline at end of file diff --git a/roles/custom/matrix-jwt-service/tasks/uninstall.yml b/roles/custom/matrix-jwt-service/tasks/uninstall.yml deleted file mode 100644 index 7338d5b95..000000000 --- a/roles/custom/matrix-jwt-service/tasks/uninstall.yml +++ /dev/null @@ -1,22 +0,0 @@ ---- -# Uninstall tasks for matrix-jwt-service - - -- name: Stop and remove jwt-service container - community.docker.docker_container: - name: "matrix-jwt-service" - state: absent - -- name: Remove jwt-service systemd service - ansible.builtin.file: - path: "{{ devture_systemd_docker_base_systemd_path }}/matrix-jwt-service.service" - state: absent - -- name: Remove matrix-jwt-service configuration files - ansible.builtin.file: - path: "{{ matrix_jwt_service_base_path }}" - state: absent - -- name: Reload systemd daemon - ansible.builtin.systemd: - daemon_reload: true \ No newline at end of file diff --git a/roles/custom/matrix-jwt-service/tasks/validate_config.yml b/roles/custom/matrix-jwt-service/tasks/validate_config.yml deleted file mode 100644 index 38e39ad60..000000000 --- a/roles/custom/matrix-jwt-service/tasks/validate_config.yml +++ /dev/null @@ -1,12 +0,0 @@ ---- -# Validate configuration for matrix-jwt-service - -- name: Fail if required matrix-jwt-service settings are not defined - ansible.builtin.fail: - msg: > - You need to define a required configuration setting (`{{ item.name }}`). - when: "item.when | bool and vars[item.name] == ''" - with_items: - - {'name': 'matrix_jwt_service_base_path', when: true} - - {'name': 'matrix_jwt_service_container_network', when: true} - - {'name': 'matrix_jwt_service_image', when: true} \ No newline at end of file diff --git a/roles/custom/matrix-jwt-service/templates/env.j2 b/roles/custom/matrix-jwt-service/templates/env.j2 deleted file mode 100644 index 7135bb087..000000000 --- a/roles/custom/matrix-jwt-service/templates/env.j2 +++ /dev/null @@ -1,4 +0,0 @@ -# Environment variables for JWT Service -LIVEKIT_KEY=devkey -LIVEKIT_URL=wss://{{ livekit_server_hostname }}:443 -LIVEKIT_SECRET={{ livekit_server_dev_key }} diff --git a/roles/custom/matrix-jwt-service/templates/labels.j2 b/roles/custom/matrix-jwt-service/templates/labels.j2 deleted file mode 100644 index 6db772236..000000000 --- a/roles/custom/matrix-jwt-service/templates/labels.j2 +++ /dev/null @@ -1,46 +0,0 @@ -{% if matrix_element_call_container_labels_traefik_enabled %} -traefik.enable=true - -# Network configuration for Traefik -{% if matrix_jwt_service_container_labels_traefik_docker_network %} -traefik.docker.network={{ matrix_jwt_service_container_labels_traefik_docker_network }} -{% endif %} - -traefik.http.services.matrix-jwt-service.loadbalancer.server.port=8080 - -{% set middlewares = [] %} - -# Path prefix handling for JWT -{% if matrix_jwt_service_container_labels_traefik_path_prefix != '/' %} -traefik.http.middlewares.matrix-jwt-service-slashless-redirect.redirectregex.regex=({{ matrix_jwt_service_container_labels_traefik_path_prefix | quote }})$ -traefik.http.middlewares.matrix-jwt-service-slashless-redirect.redirectregex.replacement=${1}/ -{% set middlewares = middlewares + ['matrix-jwt-service-slashless-redirect'] %} - -traefik.http.middlewares.matrix-jwt-service-strip-prefix.stripprefix.prefixes={{ matrix_jwt_service_container_labels_traefik_path_prefix }} -{% set middlewares = middlewares + ['matrix-jwt-service-strip-prefix'] %} -{% endif %} - -{% if matrix_jwt_service_container_labels_traefik_additional_response_headers.keys() | length > 0 %} -{% for name, value in matrix_jwt_service_container_labels_traefik_additional_response_headers.items() %} -traefik.http.middlewares.matrix-jwt-service-add-headers.headers.customresponseheaders.{{ name }}={{ value }} -{% endfor %} -{% set middlewares = middlewares + ['matrix-jwt-service-add-headers'] %} -{% endif %} - -traefik.http.routers.matrix-jwt-service.rule={{ matrix_jwt_service_container_labels_traefik_rule }} -{% if matrix_jwt_service_container_labels_traefik_priority | int > 0 %} -traefik.http.routers.matrix-jwt-service.priority={{ matrix_jwt_service_container_labels_traefik_priority }} -{% endif %} -traefik.http.routers.matrix-jwt-service.service=matrix-jwt-service -{% if middlewares | length > 0 %} -traefik.http.routers.matrix-jwt-service.middlewares={{ middlewares | join(',') }} -{% endif %} -traefik.http.routers.matrix-jwt-service.entrypoints={{ matrix_jwt_service_container_labels_traefik_entrypoints }} -traefik.http.routers.matrix-jwt-service.tls={{ matrix_jwt_service_container_labels_traefik_tls | to_json }} -{% if matrix_jwt_service_container_labels_traefik_tls %} -traefik.http.routers.matrix-jwt-service.tls.certResolver={{ matrix_jwt_service_container_labels_traefik_tls_certResolver }} -{% endif %} - -{% endif %} - -{{ matrix_jwt_service_container_labels_additional_labels }} \ No newline at end of file diff --git a/roles/custom/matrix-livekit-jwt-service/defaults/main.yml b/roles/custom/matrix-livekit-jwt-service/defaults/main.yml new file mode 100644 index 000000000..859708729 --- /dev/null +++ b/roles/custom/matrix-livekit-jwt-service/defaults/main.yml @@ -0,0 +1,81 @@ +--- + +# Project source code URL: https://github.com/element-hq/lk-jwt-service + +matrix_livekit_jwt_service_enabled: false + +matrix_livekit_jwt_service_scheme: https +matrix_livekit_jwt_service_hostname: "" +matrix_livekit_jwt_service_path_prefix: "/lk-jwt-service" + +matrix_livekit_jwt_service_base_path: "{{ matrix_base_data_path }}/livekit-jwt-service" + +matrix_livekit_jwt_service_container_network: '' + +matrix_livekit_jwt_service_container_http_host_bind_port: '' + +matrix_livekit_jwt_service_container_additional_networks: "{{ (matrix_livekit_jwt_service_container_additional_networks_auto + matrix_livekit_jwt_service_container_additional_networks_custom) | unique }}" +matrix_livekit_jwt_service_container_additional_networks_auto: [] +matrix_livekit_jwt_service_container_additional_networks_custom: [] + +# renovate: datasource=docker depName=ghcr.io/element-hq/lk-jwt-service +matrix_livekit_jwt_service_version: latest-ci + +matrix_livekit_jwt_service_container_image_self_build: false +matrix_livekit_jwt_service_container_repo: "https://github.com/element-hq/lk-jwt-service.git" +matrix_livekit_jwt_service_container_repo_version: "{{ 'main' if matrix_livekit_jwt_service_version in ['latest', 'latest-ci'] else livekit_server_version }}" +matrix_livekit_jwt_service_container_src_files_path: "{{ matrix_livekit_jwt_service_base_path }}/container-src" + +matrix_livekit_jwt_service_container_image: "{{ matrix_livekit_jwt_service_container_image_name_prefix }}element-hq/lk-jwt-service:{{ matrix_livekit_jwt_service_version }}" +matrix_livekit_jwt_service_container_image_name_prefix: "{{ 'localhost/' if matrix_livekit_jwt_service_container_image_self_build else 'ghcr.io/' }}" +matrix_livekit_jwt_service_container_image_force_pull: "{{ matrix_livekit_jwt_service_container_image.endswith(':latest') }}" + +matrix_livekit_jwt_service_container_labels_traefik_enabled: true +matrix_livekit_jwt_service_container_labels_traefik_docker_network: "{{ matrix_livekit_jwt_service_container_network }}" +matrix_livekit_jwt_service_container_labels_traefik_hostname: "{{ matrix_livekit_jwt_service_hostname }}" +# The path prefix must either be `/` or not end with a slash (e.g. `/lk-jwt-service`). +matrix_livekit_jwt_service_container_labels_traefik_path_prefix: "{{ matrix_livekit_jwt_service_path_prefix }}" +matrix_livekit_jwt_service_container_labels_traefik_rule: "Host(`{{ matrix_livekit_jwt_service_container_labels_traefik_hostname }}`){% if matrix_livekit_jwt_service_container_labels_traefik_path_prefix != '/' %} && PathPrefix(`{{ matrix_livekit_jwt_service_container_labels_traefik_path_prefix }}`){% endif %}" +matrix_livekit_jwt_service_container_labels_traefik_priority: 0 +matrix_livekit_jwt_service_container_labels_traefik_entrypoints: web-secure +matrix_livekit_jwt_service_container_labels_traefik_tls: "{{ matrix_livekit_jwt_service_container_labels_traefik_entrypoints != 'web' }}" +matrix_livekit_jwt_service_container_labels_traefik_tls_certResolver: default # noqa var-naming + +# Controls which additional headers to attach to all HTTP responses. +# To add your own headers, use `matrix_livekit_jwt_service_container_labels_traefik_additional_response_headers_custom` +matrix_livekit_jwt_service_container_labels_traefik_additional_response_headers: "{{ matrix_livekit_jwt_service_container_labels_traefik_additional_response_headers_auto | combine(matrix_livekit_jwt_service_container_labels_traefik_additional_response_headers_custom) }}" +matrix_livekit_jwt_service_container_labels_traefik_additional_response_headers_auto: {} +matrix_livekit_jwt_service_container_labels_traefik_additional_response_headers_custom: {} + +# matrix_client_element_container_labels_additional_labels contains a multiline string with additional labels to add to the container label file. +# See `../templates/labels.j2` for details. +# +# Example: +# matrix_client_element_container_labels_additional_labels: | +# my.label=1 +# another.label="here" +matrix_livekit_jwt_service_container_labels_additional_labels: '' + +# A list of extra arguments to pass to the container +matrix_livekit_jwt_service_container_extra_arguments: [] + +# Controls the LK_JWT_PORT environment variable +matrix_livekit_jwt_service_environment_variable_lk_jwt_port: 8080 + +# Controls the LIVEKIT_KEY environment variable +matrix_livekit_jwt_service_environment_variable_livekit_key: "" + +# Controls the LIVEKIT_URL environment variable +matrix_livekit_jwt_service_environment_variable_livekit_url: "" + +# Controls the LIVEKIT_SECRET environment variable +matrix_livekit_jwt_service_environment_variable_livekit_secret: "" + +# Additional environment variables for the container +matrix_livekit_jwt_service_environment_variables_additional: {} + +# List of systemd services that LiveKit JWT Service service depends on +matrix_livekit_jwt_service_systemd_required_services_list: "{{ matrix_livekit_jwt_service_systemd_required_services_list_default + matrix_livekit_jwt_service_systemd_required_services_list_auto + matrix_livekit_jwt_service_systemd_required_services_list_custom }}" +matrix_livekit_jwt_service_systemd_required_services_list_default: "{{ [devture_systemd_docker_base_docker_service_name] if devture_systemd_docker_base_docker_service_name else [] }}" +matrix_livekit_jwt_service_systemd_required_services_list_auto: [] +matrix_livekit_jwt_service_systemd_required_services_list_custom: [] diff --git a/roles/custom/matrix-livekit-jwt-service/tasks/install.yml b/roles/custom/matrix-livekit-jwt-service/tasks/install.yml new file mode 100644 index 000000000..1900ac6f3 --- /dev/null +++ b/roles/custom/matrix-livekit-jwt-service/tasks/install.yml @@ -0,0 +1,69 @@ +--- + +- name: Ensure LiveKit JWT Service paths exist + ansible.builtin.file: + path: "{{ item.path }}" + state: directory + mode: 0750 + owner: "{{ matrix_user_username }}" + group: "{{ matrix_user_groupname }}" + with_items: + - path: "{{ matrix_livekit_jwt_service_base_path }}" + +- name: Ensure LiveKit JWT Service support files installed + ansible.builtin.template: + src: "{{ role_path }}/templates/{{ item }}.j2" + dest: "{{ matrix_livekit_jwt_service_base_path }}/{{ item }}" + mode: 0640 + owner: "{{ matrix_user_username }}" + group: "{{ matrix_user_groupname }}" + with_items: + - env + - labels + +- name: Ensure LiveKit JWT Service container image is pulled + community.docker.docker_image: + name: "{{ matrix_livekit_jwt_service_container_image }}" + source: "{{ 'pull' if ansible_version.major > 2 or ansible_version.minor > 7 else omit }}" + force_source: "{{ matrix_livekit_jwt_service_container_image_force_pull if ansible_version.major > 2 or ansible_version.minor >= 8 else omit }}" + force: "{{ omit if ansible_version.major > 2 or ansible_version.minor >= 8 else matrix_livekit_jwt_service_container_image_force_pull }}" + when: "not matrix_livekit_jwt_service_container_image_self_build | bool" + register: result + retries: "{{ devture_playbook_help_container_retries_count }}" + delay: "{{ devture_playbook_help_container_retries_delay }}" + until: result is not failed + +- when: "matrix_livekit_jwt_service_container_image_self_build | bool" + block: + - name: Ensure LiveKit JWT Service repository is present on self-build + ansible.builtin.git: + repo: "{{ matrix_livekit_jwt_service_container_repo }}" + version: "{{ matrix_livekit_jwt_service_container_repo_version }}" + dest: "{{ matrix_livekit_jwt_service_container_src_files_path }}" + force: "yes" + become: true + become_user: "{{ matrix_user_username }}" + register: matrix_livekit_jwt_service_git_pull_results + + - name: Ensure LiveKit JWT Service container image is built + community.docker.docker_image: + name: "{{ matrix_livekit_jwt_service_container_image }}" + source: build + force_source: "{{ matrix_livekit_jwt_service_git_pull_results.changed if ansible_version.major > 2 or ansible_version.minor >= 8 else omit }}" + force: "{{ omit if ansible_version.major > 2 or ansible_version.minor >= 8 else matrix_livekit_jwt_service_git_pull_results.changed }}" + build: + dockerfile: Dockerfile + path: "{{ matrix_livekit_jwt_service_container_src_files_path }}" + pull: true + +- name: Ensure LiveKit JWT Service container network is created + community.general.docker_network: + enable_ipv6: "{{ devture_systemd_docker_base_ipv6_enabled }}" + name: "{{ matrix_livekit_jwt_service_container_network }}" + driver: bridge + +- name: Ensure LiveKit JWT Service systemd service is installed + ansible.builtin.template: + src: "{{ role_path }}/templates/systemd/matrix-livekit-jwt-service.service.j2" + dest: "{{ devture_systemd_docker_base_systemd_path }}/matrix-livekit-jwt-service.service" + mode: 0644 diff --git a/roles/custom/matrix-jwt-service/tasks/main.yml b/roles/custom/matrix-livekit-jwt-service/tasks/main.yml similarity index 57% rename from roles/custom/matrix-jwt-service/tasks/main.yml rename to roles/custom/matrix-livekit-jwt-service/tasks/main.yml index 8fbe41d58..7713acc1d 100644 --- a/roles/custom/matrix-jwt-service/tasks/main.yml +++ b/roles/custom/matrix-livekit-jwt-service/tasks/main.yml @@ -1,21 +1,20 @@ --- -# Main task file for matrix-element-call - tags: - setup-all - setup-jwt-service - install-all - - install-wt-service + - install-livekit-jwt-service block: - - when: matrix_jwt_service_enabled | bool + - when: matrix_livekit_jwt_service_enabled | bool ansible.builtin.include_tasks: "{{ role_path }}/tasks/validate_config.yml" - - when: matrix_jwt_service_enabled | bool + - when: matrix_livekit_jwt_service_enabled | bool ansible.builtin.include_tasks: "{{ role_path }}/tasks/install.yml" - tags: - setup-all - - setup-jwt-service + - setup-livekit-jwt-service block: - - when: not matrix_jwt_service_enabled | bool - ansible.builtin.include_tasks: "{{ role_path }}/tasks/uninstall.yml" \ No newline at end of file + - when: not matrix_livekit_jwt_service_enabled | bool + ansible.builtin.include_tasks: "{{ role_path }}/tasks/uninstall.yml" diff --git a/roles/custom/matrix-livekit-jwt-service/tasks/uninstall.yml b/roles/custom/matrix-livekit-jwt-service/tasks/uninstall.yml new file mode 100644 index 000000000..b898af8d6 --- /dev/null +++ b/roles/custom/matrix-livekit-jwt-service/tasks/uninstall.yml @@ -0,0 +1,25 @@ +--- + +- name: Check existence of LiveKit JWT Service systemd service + ansible.builtin.stat: + path: "{{ devture_systemd_docker_base_systemd_path }}/matrix-livekit-jwt-service.service" + register: matrix_livekit_jwt_service_service_stat + +- when: matrix_livekit_jwt_service_service_stat.stat.exists | bool + block: + - name: Ensure LiveKit JWT Service systemd service is stopped + ansible.builtin.service: + name: matrix-livekit-jwt-service + state: stopped + enabled: false + daemon_reload: true + + - name: Ensure LiveKit JWT Service systemd service doesn't exist + ansible.builtin.file: + path: "{{ devture_systemd_docker_base_systemd_path }}/matrix-livekit-jwt-service.service" + state: absent + + - name: Ensure LiveKit JWT Service paths don't exist + ansible.builtin.file: + path: "{{ matrix_livekit_jwt_service_base_path }}" + state: absent diff --git a/roles/custom/matrix-livekit-jwt-service/tasks/validate_config.yml b/roles/custom/matrix-livekit-jwt-service/tasks/validate_config.yml new file mode 100644 index 000000000..5d393d629 --- /dev/null +++ b/roles/custom/matrix-livekit-jwt-service/tasks/validate_config.yml @@ -0,0 +1,13 @@ +--- + +- name: Fail if required LiveKit JWT Service settings are not defined + ansible.builtin.fail: + msg: > + You need to define a required configuration setting (`{{ item.name }}`). + when: "item.when | bool and vars[item.name] | length == 0" + with_items: + - {'name': 'matrix_livekit_jwt_service_hostname', when: true} + - {'name': 'matrix_livekit_jwt_service_container_network', when: true} + - {'name': 'matrix_livekit_jwt_service_environment_variable_livekit_key', when: true} + - {'name': 'matrix_livekit_jwt_service_environment_variable_livekit_url', when: true} + - {'name': 'matrix_livekit_jwt_service_environment_variable_livekit_secret', when: true} diff --git a/roles/custom/matrix-livekit-jwt-service/templates/env.j2 b/roles/custom/matrix-livekit-jwt-service/templates/env.j2 new file mode 100644 index 000000000..d8613b453 --- /dev/null +++ b/roles/custom/matrix-livekit-jwt-service/templates/env.j2 @@ -0,0 +1,7 @@ +LK_JWT_PORT={{ matrix_livekit_jwt_service_environment_variable_lk_jwt_port | int | to_json }} + +LIVEKIT_KEY={{ matrix_livekit_jwt_service_environment_variable_livekit_key }} +LIVEKIT_URL={{ matrix_livekit_jwt_service_environment_variable_livekit_url }} +LIVEKIT_SECRET={{ matrix_livekit_jwt_service_environment_variable_livekit_secret }} + +{{ matrix_livekit_jwt_service_environment_variables_additional }} diff --git a/roles/custom/matrix-livekit-jwt-service/templates/labels.j2 b/roles/custom/matrix-livekit-jwt-service/templates/labels.j2 new file mode 100644 index 000000000..91b615a7a --- /dev/null +++ b/roles/custom/matrix-livekit-jwt-service/templates/labels.j2 @@ -0,0 +1,48 @@ +{% if matrix_element_call_container_labels_traefik_enabled %} +traefik.enable=true + +traefik.docker.network={{ matrix_livekit_jwt_service_container_labels_traefik_docker_network }} + +traefik.http.services.matrix-livekit-jwt-service.loadbalancer.server.port={{ matrix_livekit_jwt_service_environment_variable_lk_jwt_port }} + +{% set middlewares = [] %} + +{% if matrix_livekit_jwt_service_container_labels_traefik_path_prefix != '/' %} +traefik.http.middlewares.matrix-livekit-jwt-service-slashless-redirect.redirectregex.regex=({{ matrix_livekit_jwt_service_container_labels_traefik_path_prefix | quote }})$ +traefik.http.middlewares.matrix-livekit-jwt-service-slashless-redirect.redirectregex.replacement=${1}/ +{% set middlewares = middlewares + ['matrix-livekit-jwt-service-slashless-redirect'] %} + +traefik.http.middlewares.matrix-livekit-jwt-service-strip-prefix.stripprefix.prefixes={{ matrix_livekit_jwt_service_container_labels_traefik_path_prefix }} +{% set middlewares = middlewares + ['matrix-livekit-jwt-service-strip-prefix'] %} +{% endif %} + +{% if matrix_livekit_jwt_service_container_labels_traefik_additional_response_headers.keys() | length > 0 %} +{% for name, value in matrix_livekit_jwt_service_container_labels_traefik_additional_response_headers.items() %} +traefik.http.middlewares.matrix-livekit-jwt-service-add-headers.headers.customresponseheaders.{{ name }}={{ value }} +{% endfor %} +{% set middlewares = middlewares + ['matrix-livekit-jwt-service-add-headers'] %} +{% endif %} + +traefik.http.routers.matrix-livekit-jwt-service.rule={{ matrix_livekit_jwt_service_container_labels_traefik_rule }} + +{% if matrix_livekit_jwt_service_container_labels_traefik_priority | int > 0 %} +traefik.http.routers.matrix-livekit-jwt-service.priority={{ matrix_livekit_jwt_service_container_labels_traefik_priority }} +{% endif %} + +traefik.http.routers.matrix-livekit-jwt-service.service=matrix-livekit-jwt-service + +{% if middlewares | length > 0 %} +traefik.http.routers.matrix-livekit-jwt-service.middlewares={{ middlewares | join(',') }} +{% endif %} + +traefik.http.routers.matrix-livekit-jwt-service.entrypoints={{ matrix_livekit_jwt_service_container_labels_traefik_entrypoints }} + +traefik.http.routers.matrix-livekit-jwt-service.tls={{ matrix_livekit_jwt_service_container_labels_traefik_tls | to_json }} + +{% if matrix_livekit_jwt_service_container_labels_traefik_tls %} +traefik.http.routers.matrix-livekit-jwt-service.tls.certResolver={{ matrix_livekit_jwt_service_container_labels_traefik_tls_certResolver }} +{% endif %} + +{% endif %} + +{{ matrix_livekit_jwt_service_container_labels_additional_labels }} diff --git a/roles/custom/matrix-jwt-service/templates/systemd/matrix-jwt-service.service.j2 b/roles/custom/matrix-livekit-jwt-service/templates/systemd/matrix-livekit-jwt-service.service.j2 similarity index 52% rename from roles/custom/matrix-jwt-service/templates/systemd/matrix-jwt-service.service.j2 rename to roles/custom/matrix-livekit-jwt-service/templates/systemd/matrix-livekit-jwt-service.service.j2 index b940e75a2..0c2127a17 100644 --- a/roles/custom/matrix-jwt-service/templates/systemd/matrix-jwt-service.service.j2 +++ b/roles/custom/matrix-livekit-jwt-service/templates/systemd/matrix-livekit-jwt-service.service.j2 @@ -1,40 +1,42 @@ #jinja2: lstrip_blocks: "True" [Unit] -Description=Matrix JWT Service -After=docker.service -Requires=docker.service +Description=Matrix LiveKit JWT Service +{% for service in matrix_livekit_jwt_service_systemd_required_services_list %} +After={{ service }} +Requires={{ service }} +{% endfor %} [Service] Type=simple Environment="HOME={{ devture_systemd_docker_base_systemd_unit_home_path }}" -ExecStartPre=-{{ devture_systemd_docker_base_host_command_sh }} -c '{{ devture_systemd_docker_base_host_command_docker }} stop --time={{ devture_systemd_docker_base_container_stop_grace_time_seconds }} matrix-jwt-service 2>/dev/null || true' -ExecStartPre=-{{ devture_systemd_docker_base_host_command_sh }} -c '{{ devture_systemd_docker_base_host_command_docker }} rm matrix-jwt-service 2>/dev/null || true' +ExecStartPre=-{{ devture_systemd_docker_base_host_command_sh }} -c '{{ devture_systemd_docker_base_host_command_docker }} stop --time={{ devture_systemd_docker_base_container_stop_grace_time_seconds }} matrix-livekit-jwt-service 2>/dev/null || true' +ExecStartPre=-{{ devture_systemd_docker_base_host_command_sh }} -c '{{ devture_systemd_docker_base_host_command_docker }} rm matrix-livekit-jwt-service 2>/dev/null || true' ExecStartPre={{ devture_systemd_docker_base_host_command_docker }} create \ --rm \ - --name=matrix-jwt-service \ + --name=matrix-livekit-jwt-service \ --log-driver=none \ --user={{ matrix_user_uid }}:{{ matrix_user_gid }} \ --cap-drop=ALL \ - --network={{ matrix_jwt_service_container_network }} \ - {% if matrix_jwt_service_container_http_host_bind_port %} - -p {{ matrix_jwt_service_container_http_host_bind_port }}:8080 \ + --network={{ matrix_livekit_jwt_service_container_network }} \ + {% if matrix_livekit_jwt_service_container_http_host_bind_port %} + -p {{ matrix_livekit_jwt_service_container_http_host_bind_port }}:{{ matrix_livekit_jwt_service_environment_variable_lk_jwt_port }} \ {% endif %} - --env-file={{ matrix_jwt_service_base_path }}/env \ - --label-file={{ matrix_jwt_service_base_path }}/labels \ - {{ matrix_jwt_service_image }} + --env-file={{ matrix_livekit_jwt_service_base_path }}/env \ + --label-file={{ matrix_livekit_jwt_service_base_path }}/labels \ + {{ matrix_livekit_jwt_service_container_image }} -{% for network in matrix_jwt_service_container_additional_networks %} -ExecStartPre={{ devture_systemd_docker_base_host_command_docker }} network connect {{ network }} matrix-jwt-service +{% for network in matrix_livekit_jwt_service_container_additional_networks %} +ExecStartPre={{ devture_systemd_docker_base_host_command_docker }} network connect {{ network }} matrix-livekit-jwt-service {% endfor %} -ExecStart={{ devture_systemd_docker_base_host_command_docker }} start --attach matrix-jwt-service +ExecStart={{ devture_systemd_docker_base_host_command_docker }} start --attach matrix-livekit-jwt-service -ExecStop=-{{ devture_systemd_docker_base_host_command_sh }} -c '{{ devture_systemd_docker_base_host_command_docker }} stop --time={{ devture_systemd_docker_base_container_stop_grace_time_seconds }} matrix-jwt-service 2>/dev/null || true' +ExecStop=-{{ devture_systemd_docker_base_host_command_sh }} -c '{{ devture_systemd_docker_base_host_command_docker }} stop --time={{ devture_systemd_docker_base_container_stop_grace_time_seconds }} matrix-livekit-jwt-service 2>/dev/null || true' ExecStop=-{{ devture_systemd_docker_base_host_command_sh }} -c '{{ devture_systemd_docker_base_host_command_docker }} rm matrix-jwt-service 2>/dev/null || true' Restart=always RestartSec=30 -SyslogIdentifier=matrix-jwt-service +SyslogIdentifier=matrix-livekit-jwt-service [Install] -WantedBy=multi-user.target \ No newline at end of file +WantedBy=multi-user.target diff --git a/roles/custom/matrix-livekit-jwt-service/vars/main.yml b/roles/custom/matrix-livekit-jwt-service/vars/main.yml new file mode 100644 index 000000000..c2d7ce3e7 --- /dev/null +++ b/roles/custom/matrix-livekit-jwt-service/vars/main.yml @@ -0,0 +1,3 @@ +--- + +matrix_livekit_jwt_service_public_url: "{{ matrix_livekit_jwt_service_scheme }}://{{ matrix_livekit_jwt_service_hostname }}" diff --git a/roles/custom/matrix-livekit-server/defaults/main.yml b/roles/custom/matrix-livekit-server/defaults/main.yml index f8ed88fcd..5c0d8bf42 100644 --- a/roles/custom/matrix-livekit-server/defaults/main.yml +++ b/roles/custom/matrix-livekit-server/defaults/main.yml @@ -12,7 +12,7 @@ livekit_server_gid: '' livekit_server_base_path: "/{{ livekit_server_identifier }}" livekit_server_config_path: "{{ livekit_server_base_path }}/config" -# renovate: datasource=docker depName=livekit/livekit-server +# renovate: datasource=docker depName=docker.io/livekit/livekit-server livekit_server_version: v1.8.0 livekit_server_scheme: https diff --git a/roles/custom/matrix-livekit-server/tasks/install.yml b/roles/custom/matrix-livekit-server/tasks/install.yml index 7f6217969..cec65bb64 100644 --- a/roles/custom/matrix-livekit-server/tasks/install.yml +++ b/roles/custom/matrix-livekit-server/tasks/install.yml @@ -32,11 +32,43 @@ - name: Ensure LiveKit Server container image is pulled community.docker.docker_image: name: "{{ livekit_server_container_image }}" - source: pull - register: livekit_image_result + source: "{{ 'pull' if ansible_version.major > 2 or ansible_version.minor > 7 else omit }}" + force_source: "{{ livekit_server_container_image_force_pull if ansible_version.major > 2 or ansible_version.minor >= 8 else omit }}" + force: "{{ omit if ansible_version.major > 2 or ansible_version.minor >= 8 else livekit_server_container_image_force_pull }}" + when: "not livekit_server_container_image_self_build | bool" + register: result retries: "{{ devture_playbook_help_container_retries_count }}" delay: "{{ devture_playbook_help_container_retries_delay }}" - until: livekit_image_result is not failed + until: result is not failed + +- when: "livekit_server_container_image_self_build | bool" + block: + - name: Ensure LiveKit Server repository is present on self-build + ansible.builtin.git: + repo: "{{ livekit_server_container_repo }}" + version: "{{ livekit_server_container_repo_version }}" + dest: "{{ livekit_server_container_src_files_path }}" + force: "yes" + become: true + become_user: "{{ matrix_user_username }}" + register: livekit_server_git_pull_results + + - name: Ensure LiveKit Server container image is built + community.docker.docker_image: + name: "{{ livekit_server_container_image }}" + source: build + force_source: "{{ livekit_server_git_pull_results.changed if ansible_version.major > 2 or ansible_version.minor >= 8 else omit }}" + force: "{{ omit if ansible_version.major > 2 or ansible_version.minor >= 8 else livekit_server_git_pull_results.changed }}" + build: + dockerfile: Dockerfile + path: "{{ livekit_server_container_src_files_path }}" + pull: true + +- name: Ensure LiveKit Server container network is created + community.general.docker_network: + enable_ipv6: "{{ devture_systemd_docker_base_ipv6_enabled }}" + name: "{{ livekit_server_container_network }}" + driver: bridge - name: Ensure LiveKit Server systemd service is installed ansible.builtin.template: diff --git a/roles/custom/matrix-livekit-server/templates/systemd/livekit-server.service.j2 b/roles/custom/matrix-livekit-server/templates/systemd/livekit-server.service.j2 index cb56801ff..6ff03d660 100644 --- a/roles/custom/matrix-livekit-server/templates/systemd/livekit-server.service.j2 +++ b/roles/custom/matrix-livekit-server/templates/systemd/livekit-server.service.j2 @@ -1,8 +1,10 @@ #jinja2: lstrip_blocks: "True" [Unit] Description=LiveKit Server -After=docker.service -Requires=docker.service +{% for service in livekit_server_systemd_required_services_list %} +After={{ service }} +Requires={{ service }} +{% endfor %} [Service] Type=simple diff --git a/roles/custom/matrix-livekit-server/vars/main.yml b/roles/custom/matrix-livekit-server/vars/main.yml index e2f8c0ee7..87f0be0dd 100644 --- a/roles/custom/matrix-livekit-server/vars/main.yml +++ b/roles/custom/matrix-livekit-server/vars/main.yml @@ -1 +1,3 @@ livekit_server_public_url: "{{ livekit_server_scheme }}://{{ livekit_server_hostname }}{{ livekit_server_path_prefix }}" + +livekit_server_websocket_container_url: "ws://{{ livekit_server_identifier }}:{{ livekit_server_config_port}}" diff --git a/setup.yml b/setup.yml index 2cb9a41a3..86b9dfa7f 100644 --- a/setup.yml +++ b/setup.yml @@ -135,7 +135,7 @@ - custom/matrix-pantalaimon - custom/matrix-element-call - custom/matrix-livekit-server - - custom/matrix-jwt-service + - custom/matrix-livekit-jwt-service - role: galaxy/postgres_backup