diff --git a/README.md b/README.md index ed42d2917..b3af354b6 100644 --- a/README.md +++ b/README.md @@ -133,7 +133,7 @@ Bridges can be used to connect your Matrix installation with third-party communi | [matrix-hookshot](https://github.com/matrix-org/matrix-hookshot) | ❌ | Bridge for generic webhooks and multiple project management services, such as GitHub, GitLab, Figma, and Jira in particular | [Link](docs/configuring-playbook-bridge-hookshot.md) | | [matrix-sms-bridge](https://github.com/benkuly/matrix-sms-bridge) | ❌ | Bridge to SMS | [Link](docs/configuring-playbook-bridge-matrix-bridge-sms.md) | | [matrix-wechat](https://github.com/duo/matrix-wechat) | ❌ | Bridge to [WeChat](https://www.wechat.com/) | [Link](docs/configuring-playbook-bridge-wechat.md) | -| [MatrixZulipBridge](https://github.com/GearKite/MatrixZulipBridge) | ❌ | Puppeting appservice bridge for [Zulip](https://zulip.com/) | [Link](docs/configuring-playbook-bridge-matrixzulipbridge.md) | +| [MatrixZulipBridge](https://github.com/GearKite/MatrixZulipBridge) | ❌ | Puppeting appservice bridge for [Zulip](https://zulip.com/) | [Link](docs/configuring-playbook-bridge-zulip.md) | | [Heisenbridge](https://github.com/hifi/heisenbridge) | ❌ | Bouncer-style bridge to [IRC](https://wikipedia.org/wiki/Internet_Relay_Chat) | [Link](docs/configuring-playbook-bridge-heisenbridge.md) | | [go-skype-bridge](https://github.com/kelaresg/go-skype-bridge) | ❌ | Bridge to [Skype](https://www.skype.com) | [Link](docs/configuring-playbook-bridge-go-skype-bridge.md) | | [mx-puppet-slack](https://gitlab.com/mx-puppet/slack/mx-puppet-slack) | ❌ | Bridge to [Slack](https://slack.com) | [Link](docs/configuring-playbook-bridge-mx-puppet-slack.md) | diff --git a/docs/configuring-playbook-bridge-matrixzulipbridge.md b/docs/configuring-playbook-bridge-zulip.md similarity index 70% rename from docs/configuring-playbook-bridge-matrixzulipbridge.md rename to docs/configuring-playbook-bridge-zulip.md index 0fdd42ac7..b4eac02b9 100644 --- a/docs/configuring-playbook-bridge-matrixzulipbridge.md +++ b/docs/configuring-playbook-bridge-zulip.md @@ -14,7 +14,7 @@ See the project's [documentation](https://github.com/GearKite/MatrixZulipBridge/ ## Adjusting DNS records (optional) -By default, this playbook installs MatrixZulipBridge on the `matrix.` subdomain, at the `/matrixzulipbridge` path (https://matrix.example.com/matrixzulipbridge). This makes it easy to install it, because it **doesn't require additional DNS records to be set up**. If that's okay, you can skip this section. +By default, this playbook installs MatrixZulipBridge on the `matrix.` subdomain, at the `/zulip` path (https://matrix.example.com/zulip). This makes it easy to install it, because it **doesn't require additional DNS records to be set up**. If that's okay, you can skip this section. If you wish to adjust it, see the section [below](#adjusting-the-matrixzulipbridge-url-optional) for details about DNS configuration. @@ -23,29 +23,29 @@ If you wish to adjust it, see the section [below](#adjusting-the-matrixzulipbrid To enable MatrixZulipBridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file: ```yaml -matrix_matrixzulipbridge_enabled: true +matrix_bridge_zulip_enabled: true # Setting the owner is optional as the first local user to DM `@matrixzulipbridge:example.com` will be made the owner. # If you are not using a local user you must set it as otherwise you can't DM it at all. -matrix_matrixzulipbridge_owner: "@alice:{{ matrix_domain }}" +matrix_bridge_zulip_owner: "@alice:{{ matrix_domain }}" # Uncomment to enable identd on host port 113/TCP (optional) -# matrix_matrixzulipbridge_identd_enabled: true +# matrix_bridge_zulip_identd_enabled: true ``` ### Adjusting the MatrixZulipBridge URL (optional) -By tweaking the `matrix_matrixzulipbridge_hostname` and `matrix_matrixzulipbridge_path_prefix` variables, you can easily make the service available at a **different hostname and/or path** than the default one. +By tweaking the `matrix_bridge_zulip_hostname` and `matrix_bridge_zulip_path_prefix` variables, you can easily make the service available at a **different hostname and/or path** than the default one. Example additional configuration for your `vars.yml` file: ```yaml # Change the default hostname and path prefix -matrix_matrixzulipbridge_hostname: matrixzulipbridge.example.com -matrix_matrixzulipbridge_path_prefix: / +matrix_bridge_zulip_hostname: zulip.example.com +matrix_bridge_zulip_path_prefix: / ``` -If you've changed the default hostname, you may need to create a CNAME record for the MatrixZulipBridge domain (`matrixzulipbridge.example.com`), which targets `matrix.example.com`. +If you've changed the default hostname, you may need to create a CNAME record for the MatrixZulipBridge domain (`zulip.example.com`), which targets `matrix.example.com`. When setting, replace `example.com` with your own. @@ -55,7 +55,7 @@ There are some additional things you may wish to configure about the bridge. Take a look at: -- `roles/custom/matrix-bridge-matrixzulipbridge/defaults/main.yml` for some variables that you can customize via your `vars.yml` file +- `roles/custom/matrix-bridge-zulip/defaults/main.yml` for some variables that you can customize via your `vars.yml` file ## Installing @@ -72,10 +72,10 @@ The shortcut commands with the [`just` program](just.md) are also available: `ju ## Usage -To use the bridge, you need to start a chat with `@zulipbridge:example.com` (where `example.com` is your base domain, not the `matrix.` domain). If the bridge ignores you and a DM is not accepted then the owner setting may be wrong. +To use the bridge, you need to start a chat with `@matrixzulipbridge:example.com` (where `example.com` is your base domain, not the `matrix.` domain). If the bridge ignores you and a DM is not accepted then the owner setting may be wrong. If you encounter issues or feel lost you can join the project room at [#matrixzulipbridge:shema.lv](https://matrix.to/#/#matrixzulipbridge:shema.lv) for help. ## Troubleshooting -As with all other services, you can find the logs in [systemd-journald](https://www.freedesktop.org/software/systemd/man/systemd-journald.service.html) by logging in to the server with SSH and running `journalctl -fu matrix-matrixzulipbridge`. +As with all other services, you can find the logs in [systemd-journald](https://www.freedesktop.org/software/systemd/man/systemd-journald.service.html) by logging in to the server with SSH and running `journalctl -fu matrix-bridge-zulip`. diff --git a/docs/configuring-playbook.md b/docs/configuring-playbook.md index 3f0a3feb8..caa36c279 100644 --- a/docs/configuring-playbook.md +++ b/docs/configuring-playbook.md @@ -194,7 +194,7 @@ Bridges can be used to connect your Matrix installation with third-party communi - [Setting up Matrix SMS bridging](configuring-playbook-bridge-matrix-bridge-sms.md) -- [Setting up MatrixZulipBridge](configuring-playbook-bridge-matrixzulipbridge.md) +- [Setting up MatrixZulipBridge](configuring-playbook-bridge-zulip.md) - [Setting up Heisenbridge bouncer-style IRC bridging](configuring-playbook-bridge-heisenbridge.md) diff --git a/docs/container-images.md b/docs/container-images.md index 5d8e73314..831c0dbb9 100644 --- a/docs/container-images.md +++ b/docs/container-images.md @@ -107,7 +107,7 @@ Bridges can be used to connect your Matrix installation with third-party communi | [matrix-hookshot](configuring-playbook-bridge-hookshot.md) | [halfshot/matrix-hookshot](https://hub.docker.com/r/halfshot/matrix-hookshot) | ❌ | Bridge for generic webhooks and multiple project management services, such as GitHub, GitLab, Figma, and Jira in particular | | [matrix-sms-bridge](configuring-playbook-bridge-matrix-bridge-sms.md) | [folivonet/matrix-sms-bridge](https://hub.docker.com/repository/docker/folivonet/matrix-sms-bridge) | ❌ | Bridge to SMS | | [matrix-wechat](configuring-playbook-bridge-wechat.md) | [lxduo/matrix-wechat](https://hub.docker.com/r/lxduo/matrix-wechat) | ❌ | Bridge to [WeChat](https://www.wechat.com/) | -| [MatrixZulipBridge](configuring-playbook-bridge-matrixzulipbridge.md) | [GearKite/MatrixZulipBridge](https://ghcr.io/gearkite/matrixzulipbridge) | ❌ | Puppeting appservice bridge for [Zulip](https://zulip.com/) | +| [MatrixZulipBridge](configuring-playbook-bridge-zulip.md) | [GearKite/MatrixZulipBridge](https://ghcr.io/gearkite/matrixzulipbridge) | ❌ | Puppeting appservice bridge for [Zulip](https://zulip.com/) | | [Heisenbridge](configuring-playbook-bridge-heisenbridge.md) | [hif1/heisenbridge](https://hub.docker.com/r/hif1/heisenbridge) | ❌ | Bouncer-style bridge to [IRC](https://wikipedia.org/wiki/Internet_Relay_Chat) | | [go-skype-bridge](configuring-playbook-bridge-go-skype-bridge.md) | [nodefyme/go-skype-bridge](https://hub.docker.com/r/nodefyme/go-skype-bridge) | ❌ | Bridge to [Skype](https://www.skype.com) | | [mx-puppet-slack](configuring-playbook-bridge-mx-puppet-slack.md) | [mx-puppet/slack/mx-puppet-slack](https://gitlab.com/mx-puppet/slack/mx-puppet-slack/container_registry) | ❌ | Bridge to [Slack](https://slack.com) | diff --git a/group_vars/matrix_servers b/group_vars/matrix_servers index a17661f42..724d1bffa 100755 --- a/group_vars/matrix_servers +++ b/group_vars/matrix_servers @@ -118,7 +118,7 @@ matrix_homeserver_container_extra_arguments_auto: | + (['--mount type=bind,src=' + matrix_hookshot_base_path + '/registration.yml,dst=/hookshot-registration.yml,ro'] if matrix_hookshot_enabled else []) + - (['--mount type=bind,src=' + matrix_matrixzulipbridge_base_path + '/registration.yaml,dst=/matrixzulipbridge-registration.yaml,ro'] if matrix_matrixzulipbridge_enabled else []) + (['--mount type=bind,src=' + matrix_bridge_zulip_base_path + '/registration.yaml,dst=/matrixzulipbridge-registration.yaml,ro'] if matrix_bridge_zulip_enabled else []) + (['--mount type=bind,src=' + matrix_mautrix_bluesky_config_path + '/registration.yaml,dst=/matrix-mautrix-bluesky-registration.yaml,ro'] if matrix_mautrix_bluesky_enabled else []) + @@ -195,7 +195,7 @@ matrix_homeserver_app_service_config_files_auto: | + (['/hookshot-registration.yml'] if matrix_hookshot_enabled else []) + - (['/matrixzulipbridge-registration.yaml'] if matrix_matrixzulipbridge_enabled else []) + (['/matrixzulipbridge-registration.yaml'] if matrix_bridge_zulip_enabled else []) + (['/matrix-mautrix-bluesky-registration.yaml'] if matrix_mautrix_bluesky_enabled else []) + @@ -343,7 +343,7 @@ devture_systemd_service_manager_services_list_auto: | + ([{'name': 'matrix-hookshot.service', 'priority': 2000, 'groups': ['matrix', 'bridges', 'hookshot', 'bridge-hookshot']}] if matrix_hookshot_enabled else []) + - ([{'name': 'matrix-matrixzulipbridge.service', 'priority': 2000, 'groups': ['matrix', 'bridges', 'matrixzulipbridge']}] if matrix_matrixzulipbridge_enabled else []) + ([{'name': 'matrix-bridge-zulip.service', 'priority': 2000, 'groups': ['matrix', 'bridges', 'matrixzulipbridge']}] if matrix_bridge_zulip_enabled else []) + ([{'name': 'matrix-mautrix-bluesky.service', 'priority': 2000, 'groups': ['matrix', 'bridges', 'mautrix-bluesky']}] if matrix_mautrix_bluesky_enabled else []) + @@ -2378,47 +2378,47 @@ matrix_hookshot_public_hostname: "{{ matrix_server_fqn_matrix }}" ###################################################################### # -# matrix-bridge-matrixzulipbridge +# matrix-bridge-zulip # ###################################################################### # We don't enable bridges by default. -matrix_matrixzulipbridge_enabled: false +matrix_bridge_zulip_enabled: false -matrix_matrixzulipbridge_scheme: "{{ 'https' if matrix_playbook_ssl_enabled else 'http' }}" +matrix_bridge_zulip_scheme: "{{ 'https' if matrix_playbook_ssl_enabled else 'http' }}" -matrix_matrixzulipbridge_systemd_required_services_list_auto: | +matrix_bridge_zulip_systemd_required_services_list_auto: | {{ matrix_addons_homeserver_systemd_services_list }} -matrix_matrixzulipbridge_docker_image_registry_prefix_upstream: "{{ matrix_container_global_registry_prefix_override if matrix_container_global_registry_prefix_override else matrix_matrixzulipbridge_docker_image_registry_prefix_upstream_default }}" +matrix_bridge_zulip_docker_image_registry_prefix_upstream: "{{ matrix_container_global_registry_prefix_override if matrix_container_global_registry_prefix_override else matrix_bridge_zulip_docker_image_registry_prefix_upstream_default }}" -matrix_matrixzulipbridge_container_network: "{{ matrix_addons_container_network }}" +matrix_bridge_zulip_container_network: "{{ matrix_addons_container_network }}" -matrix_matrixzulipbridge_container_additional_networks_auto: |- +matrix_bridge_zulip_container_additional_networks_auto: |- {{ ( ([] if matrix_addons_homeserver_container_network == '' else [matrix_addons_homeserver_container_network]) + - [matrix_playbook_reverse_proxyable_services_additional_network] if (matrix_matrixzulipbridge_container_labels_traefik_enabled and matrix_playbook_reverse_proxyable_services_additional_network) else [] + [matrix_playbook_reverse_proxyable_services_additional_network] if (matrix_bridge_zulip_container_labels_traefik_enabled and matrix_playbook_reverse_proxyable_services_additional_network) else [] ) | unique }} -matrix_matrixzulipbridge_container_labels_traefik_enabled: "{{ matrix_playbook_reverse_proxy_type in ['playbook-managed-traefik', 'other-traefik-container'] }}" -matrix_matrixzulipbridge_container_labels_traefik_docker_network: "{{ matrix_playbook_reverse_proxyable_services_additional_network }}" -matrix_matrixzulipbridge_container_labels_traefik_entrypoints: "{{ traefik_entrypoint_primary }}" -matrix_matrixzulipbridge_container_labels_traefik_tls_certResolver: "{{ traefik_certResolver_primary }}" +matrix_bridge_zulip_container_labels_traefik_enabled: "{{ matrix_playbook_reverse_proxy_type in ['playbook-managed-traefik', 'other-traefik-container'] }}" +matrix_bridge_zulip_container_labels_traefik_docker_network: "{{ matrix_playbook_reverse_proxyable_services_additional_network }}" +matrix_bridge_zulip_container_labels_traefik_entrypoints: "{{ traefik_entrypoint_primary }}" +matrix_bridge_zulip_container_labels_traefik_tls_certResolver: "{{ traefik_certResolver_primary }}" -matrix_matrixzulipbridge_appservice_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'zulip.as.tok', rounds=655555) | to_uuid }}" +matrix_bridge_zulip_appservice_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'zulip.as.tok', rounds=655555) | to_uuid }}" -matrix_matrixzulipbridge_homeserver_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'zulip.hs.tok', rounds=655555) | to_uuid }}" +matrix_bridge_zulip_homeserver_token: "{{ '%s' | format(matrix_homeserver_generic_secret_key) | password_hash('sha512', 'zulip.hs.tok', rounds=655555) | to_uuid }}" -matrix_matrixzulipbridge_homeserver_url: "{{ matrix_addons_homeserver_client_api_url }}" +matrix_bridge_zulip_homeserver_url: "{{ matrix_addons_homeserver_client_api_url }}" ###################################################################### # -# /matrix-bridge-matrixzulipbridge +# /matrix-bridge-zulip # ###################################################################### @@ -5357,7 +5357,7 @@ matrix_synapse_admin_config_asManagedUsers_auto: | ([ '^@matrixzulipbridge:'+(matrix_domain | regex_escape)+'$', '^@zulip_[a-zA-Z0-9]+:'+(matrix_domain | regex_escape)+'$', - ] if matrix_matrixzulipbridge_enabled else []) + ] if matrix_bridge_zulip_enabled else []) + ([ '^@'+(matrix_mautrix_bluesky_appservice_bot_username | default('') | regex_escape)+':'+(matrix_domain | regex_escape)+'$', diff --git a/roles/custom/matrix-bridge-matrixzulipbridge/defaults/main.yml b/roles/custom/matrix-bridge-matrixzulipbridge/defaults/main.yml deleted file mode 100644 index e19582a48..000000000 --- a/roles/custom/matrix-bridge-matrixzulipbridge/defaults/main.yml +++ /dev/null @@ -1,125 +0,0 @@ -# SPDX-FileCopyrightText: 2021 - 2022 Toni Spets -# SPDX-FileCopyrightText: 2022 - 2023 Nikita Chernyi -# SPDX-FileCopyrightText: 2022 - 2025 Slavi Pantaleev -# SPDX-FileCopyrightText: 2022 MDAD project contributors -# SPDX-FileCopyrightText: 2022 Marko Weltzer -# SPDX-FileCopyrightText: 2023 Samuel Meenzen -# SPDX-FileCopyrightText: 2024 - 2025 Suguru Hirahara -# -# SPDX-License-Identifier: AGPL-3.0-or-later - ---- -# MatrixZulipBridge is a puppeting appservice bridge for Zulip -# Project source code URL: https://github.com/GearKite/MatrixZulipBridge - -matrix_matrixzulipbridge_enabled: true - -matrix_matrixzulipbridge_scheme: https -matrix_matrixzulipbridge_hostname: "{{ matrix_server_fqn_matrix }}" -matrix_matrixzulipbridge_path_prefix: "/matrixzulipbridge" - -# renovate: datasource=docker depName=ghcr.io/gearkite/matrixzulipbridge -matrix_matrixzulipbridge_version: v0.4.1 -matrix_matrixzulipbridge_docker_image: "{{ matrix_matrixzulipbridge_docker_image_registry_prefix }}gearkite/matrixzulipbridge:{{ matrix_matrixzulipbridge_version }}" -matrix_matrixzulipbridge_docker_image_registry_prefix: "{{ matrix_matrixzulipbridge_docker_image_registry_prefix_upstream }}" -matrix_matrixzulipbridge_docker_image_registry_prefix_upstream: "{{ matrix_matrixzulipbridge_docker_image_registry_prefix_upstream_default }}" -matrix_matrixzulipbridge_docker_image_registry_prefix_upstream_default: ghcr.io/ -matrix_matrixzulipbridge_docker_image_force_pull: "{{ matrix_matrixzulipbridge_docker_image.endswith(':latest') }}" - -# Set this to your Matrix ID if you want to enforce the owner, otherwise first _local_ user becomes one -matrix_matrixzulipbridge_owner: "" - -matrix_matrixzulipbridge_base_path: "{{ matrix_base_data_path }}/matrixzulipbridge" - -matrix_matrixzulipbridge_container_network: "" - -# The port number in the container -matrix_matrixzulipbridge_container_http_port: 9898 - -matrix_matrixzulipbridge_container_additional_networks: "{{ matrix_matrixzulipbridge_container_additional_networks_auto + matrix_matrixzulipbridge_container_additional_networks_custom }}" -matrix_matrixzulipbridge_container_additional_networks_auto: [] -matrix_matrixzulipbridge_container_additional_networks_custom: [] - -# Controls how long to wait for the container to stop gracefully before killing it. -# We use a small value here, because this container does not seem to handle the SIGTERM signal. -matrix_matrixzulipbridge_container_stop_grace_time_seconds: 1 - -# matrix_matrixzulipbridge_container_labels_traefik_enabled controls whether labels to assist a Traefik reverse-proxy will be attached to the container. -# See `../templates/labels.j2` for details. -# -# To inject your own other container labels, see `matrix_matrixzulipbridge_container_labels_additional_labels`. -matrix_matrixzulipbridge_container_labels_traefik_enabled: true -matrix_matrixzulipbridge_container_labels_traefik_docker_network: "{{ matrix_matrixzulipbridge_container_network }}" -matrix_matrixzulipbridge_container_labels_traefik_hostname: "{{ matrix_matrixzulipbridge_hostname }}" -matrix_matrixzulipbridge_container_labels_traefik_path_prefix: "{{ matrix_matrixzulipbridge_path_prefix }}" -matrix_matrixzulipbridge_container_labels_traefik_entrypoints: web-secure -matrix_matrixzulipbridge_container_labels_traefik_tls_certResolver: default # noqa var-naming - -# Controls if the media router is enabled -matrix_matrixzulipbridge_container_labels_traefik_media_enabled: true -matrix_matrixzulipbridge_container_labels_traefik_media_hostname: "{{ matrix_matrixzulipbridge_container_labels_traefik_hostname }}" -# The path prefix must either be `/` or not end with a slash (e.g. `/matrixzulipbridge`). -matrix_matrixzulipbridge_container_labels_traefik_media_path_prefix: "{{ '' if matrix_matrixzulipbridge_container_labels_traefik_path_prefix == '/' else (matrix_matrixzulipbridge_container_labels_traefik_path_prefix) }}/_matrixzulipbridge/media" -matrix_matrixzulipbridge_container_labels_traefik_media_rule: "Host(`{{ matrix_matrixzulipbridge_container_labels_traefik_media_hostname }}`){% if matrix_matrixzulipbridge_container_labels_traefik_media_path_prefix != '/' %} && PathPrefix(`{{ matrix_matrixzulipbridge_container_labels_traefik_media_path_prefix }}`){% endif %}" -matrix_matrixzulipbridge_container_labels_traefik_media_priority: 0 -matrix_matrixzulipbridge_container_labels_traefik_media_entrypoints: "{{ matrix_matrixzulipbridge_container_labels_traefik_entrypoints }}" -matrix_matrixzulipbridge_container_labels_traefik_media_tls: "{{ matrix_matrixzulipbridge_container_labels_traefik_media_entrypoints != 'web' }}" -matrix_matrixzulipbridge_container_labels_traefik_media_tls_certResolver: "{{ matrix_matrixzulipbridge_container_labels_traefik_tls_certResolver }}" # noqa var-naming - -# matrix_matrixzulipbridge_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_matrixzulipbridge_container_labels_additional_labels: | -# my.label=1 -# another.label="here" -matrix_matrixzulipbridge_container_labels_additional_labels: '' - -# A list of extra arguments to pass to the container -matrix_matrixzulipbridge_container_extra_arguments: [] - -# List of systemd services that service depends on. -matrix_matrixzulipbridge_systemd_required_services_list: "{{ matrix_matrixzulipbridge_systemd_required_services_list_default + matrix_matrixzulipbridge_systemd_required_services_list_auto + matrix_matrixzulipbridge_systemd_required_services_list_custom }}" -matrix_matrixzulipbridge_systemd_required_services_list_default: "{{ [devture_systemd_docker_base_docker_service_name] if devture_systemd_docker_base_docker_service_name else [] }}" -matrix_matrixzulipbridge_systemd_required_services_list_auto: [] -matrix_matrixzulipbridge_systemd_required_services_list_custom: [] - -# List of systemd services that service wants -matrix_matrixzulipbridge_systemd_wanted_services_list: [] - -matrix_matrixzulipbridge_homeserver_url: "" - -matrix_matrixzulipbridge_appservice_token: '' -matrix_matrixzulipbridge_homeserver_token: '' - -matrix_matrixzulipbridge_config_media_url: "{{ matrix_matrixzulipbridge_scheme }}://{{ matrix_matrixzulipbridge_hostname }}" -# This matches the hardcoded `DEFAULT_MEDIA_PATH` in MatrixZulipBridge, but uses `matrix_matrixzulipbridge_path_prefix` as the path prefix. -# See: https://github.com/GearKite/MatrixZulipBridge/blob/2ba51f3da2ad8bd33460c953ef91a9cfc585a2d4/matrixzulipbridge/__main__.py#L87 -matrix_matrixzulipbridge_config_media_path: "{{ matrix_matrixzulipbridge_container_labels_traefik_media_path_prefix }}/v3/download/{netloc}{path}{filename}" -matrix_matrixzulipbridge_config_media_key: "{{ matrix_matrixzulipbridge_homeserver_token }}" -matrix_matrixzulipbridge_config_displayname: "MatrixZulipBridge" - -matrix_matrixzulipbridge_registration_yaml_matrixzulipbridge: - media_url: "{{ matrix_matrixzulipbridge_config_media_url }}" - media_path: "{{ matrix_matrixzulipbridge_config_media_path }}" - media_key: "{{ matrix_matrixzulipbridge_config_media_key }}" - displayname: "{{ matrix_matrixzulipbridge_config_displayname }}" - -# Default registration file consumed by both the homeserver and MatrixZulipBridge. -# Besides registration information, it contains configuration (see the MatrixZulipBridge key). -matrix_matrixzulipbridge_registration_yaml: - id: zulipbridge - url: http://matrix-matrixzulipbridge:{{ matrix_matrixzulipbridge_container_http_port }} - as_token: "{{ matrix_matrixzulipbridge_appservice_token }}" - hs_token: "{{ matrix_matrixzulipbridge_homeserver_token }}" - rate_limited: false - sender_localpart: zulipbridge - namespaces: - users: - - regex: '@zulip_.*' - exclusive: true - aliases: [] - rooms: [] - matrixzulipbridge: "{{ matrix_matrixzulipbridge_registration_yaml_matrixzulipbridge }}" - -matrix_matrixzulipbridge_registration: "{{ matrix_matrixzulipbridge_registration_yaml | from_yaml }}" diff --git a/roles/custom/matrix-bridge-matrixzulipbridge/templates/labels.j2 b/roles/custom/matrix-bridge-matrixzulipbridge/templates/labels.j2 deleted file mode 100644 index 22f109881..000000000 --- a/roles/custom/matrix-bridge-matrixzulipbridge/templates/labels.j2 +++ /dev/null @@ -1,58 +0,0 @@ -{# -SPDX-FileCopyrightText: 2024 Slavi Pantaleev - -SPDX-License-Identifier: AGPL-3.0-or-later -#} - -{% if matrix_matrixzulipbridge_container_labels_traefik_enabled %} -traefik.enable=true - -{% if matrix_matrixzulipbridge_container_labels_traefik_docker_network %} -traefik.docker.network={{ matrix_matrixzulipbridge_container_labels_traefik_docker_network }} -{% endif %} - -traefik.http.services.matrix-matrixzulipbridge.loadbalancer.server.port={{ matrix_matrixzulipbridge_container_http_port }} - -{% set middlewares = [] %} - -{% if matrix_matrixzulipbridge_container_labels_traefik_path_prefix != '/' %} -traefik.http.middlewares.matrix-matrixzulipbridge-strip-prefix.stripprefix.prefixes={{ matrix_matrixzulipbridge_container_labels_traefik_path_prefix }} -{% set middlewares = middlewares + ['matrix-matrixzulipbridge-strip-prefix'] %} -{% endif %} - -{% if matrix_matrixzulipbridge_container_labels_traefik_media_enabled %} -########################################################################## -# # -# Media # -# # -########################################################################## - -traefik.http.routers.matrix-matrixzulipbridge-media.rule={{ matrix_matrixzulipbridge_container_labels_traefik_media_rule }} - -{% if matrix_matrixzulipbridge_container_labels_traefik_media_priority | int > 0 %} -traefik.http.routers.matrix-matrixzulipbridge-media.priority={{ matrix_matrixzulipbridge_container_labels_traefik_media_priority }} -{% endif %} - -{% if middlewares | length > 0 %} -traefik.http.routers.matrix-matrixzulipbridge-media.middlewares={{ middlewares | join(',') }} -{% endif %} - -traefik.http.routers.matrix-matrixzulipbridge-media.service=matrix-matrixzulipbridge -traefik.http.routers.matrix-matrixzulipbridge-media.entrypoints={{ matrix_matrixzulipbridge_container_labels_traefik_entrypoints }} - -traefik.http.routers.matrix-matrixzulipbridge-media.tls={{ matrix_matrixzulipbridge_container_labels_traefik_media_tls | to_json }} -{% if matrix_matrixzulipbridge_container_labels_traefik_media_entrypoints %} -traefik.http.routers.matrix-matrixzulipbridge-media.tls.certResolver={{ matrix_matrixzulipbridge_container_labels_traefik_media_tls_certResolver }} -{% endif %} - -########################################################################## -# # -# /Media # -# # -########################################################################## -{% endif %} - - -{% endif %} - -{{ matrix_matrixzulipbridge_container_labels_additional_labels }} diff --git a/roles/custom/matrix-bridge-zulip/defaults/main.yml b/roles/custom/matrix-bridge-zulip/defaults/main.yml new file mode 100644 index 000000000..11af8410f --- /dev/null +++ b/roles/custom/matrix-bridge-zulip/defaults/main.yml @@ -0,0 +1,125 @@ +# SPDX-FileCopyrightText: 2021 - 2022 Toni Spets +# SPDX-FileCopyrightText: 2022 - 2023 Nikita Chernyi +# SPDX-FileCopyrightText: 2022 - 2025 Slavi Pantaleev +# SPDX-FileCopyrightText: 2022 MDAD project contributors +# SPDX-FileCopyrightText: 2022 Marko Weltzer +# SPDX-FileCopyrightText: 2023 Samuel Meenzen +# SPDX-FileCopyrightText: 2024 - 2025 Suguru Hirahara +# +# SPDX-License-Identifier: AGPL-3.0-or-later + +--- +# MatrixZulipBridge is a puppeting appservice bridge for Zulip +# Project source code URL: https://github.com/GearKite/MatrixZulipBridge + +matrix_bridge_zulip_enabled: true + +matrix_bridge_zulip_scheme: https +matrix_bridge_zulip_hostname: "{{ matrix_server_fqn_matrix }}" +matrix_bridge_zulip_path_prefix: "/zulip" + +# renovate: datasource=docker depName=ghcr.io/gearkite/matrixzulipbridge +matrix_bridge_zulip_version: v0.4.1 +matrix_bridge_zulip_docker_image: "{{ matrix_bridge_zulip_docker_image_registry_prefix }}gearkite/matrixzulipbridge:{{ matrix_bridge_zulip_version }}" +matrix_bridge_zulip_docker_image_registry_prefix: "{{ matrix_bridge_zulip_docker_image_registry_prefix_upstream }}" +matrix_bridge_zulip_docker_image_registry_prefix_upstream: "{{ matrix_bridge_zulip_docker_image_registry_prefix_upstream_default }}" +matrix_bridge_zulip_docker_image_registry_prefix_upstream_default: ghcr.io/ +matrix_bridge_zulip_docker_image_force_pull: "{{ matrix_bridge_zulip_docker_image.endswith(':latest') }}" + +# Set this to your Matrix ID if you want to enforce the owner, otherwise first _local_ user becomes one +matrix_bridge_zulip_owner: "" + +matrix_bridge_zulip_base_path: "{{ matrix_base_data_path }}/zulip" + +matrix_bridge_zulip_container_network: "" + +# The port number in the container +matrix_bridge_zulip_container_http_port: 9898 + +matrix_bridge_zulip_container_additional_networks: "{{ matrix_bridge_zulip_container_additional_networks_auto + matrix_bridge_zulip_container_additional_networks_custom }}" +matrix_bridge_zulip_container_additional_networks_auto: [] +matrix_bridge_zulip_container_additional_networks_custom: [] + +# Controls how long to wait for the container to stop gracefully before killing it. +# We use a small value here, because this container does not seem to handle the SIGTERM signal. +matrix_bridge_zulip_container_stop_grace_time_seconds: 1 + +# matrix_bridge_zulip_container_labels_traefik_enabled controls whether labels to assist a Traefik reverse-proxy will be attached to the container. +# See `../templates/labels.j2` for details. +# +# To inject your own other container labels, see `matrix_bridge_zulip_container_labels_additional_labels`. +matrix_bridge_zulip_container_labels_traefik_enabled: true +matrix_bridge_zulip_container_labels_traefik_docker_network: "{{ matrix_bridge_zulip_container_network }}" +matrix_bridge_zulip_container_labels_traefik_hostname: "{{ matrix_bridge_zulip_hostname }}" +matrix_bridge_zulip_container_labels_traefik_path_prefix: "{{ matrix_bridge_zulip_path_prefix }}" +matrix_bridge_zulip_container_labels_traefik_entrypoints: web-secure +matrix_bridge_zulip_container_labels_traefik_tls_certResolver: default # noqa var-naming + +# Controls if the media router is enabled +matrix_bridge_zulip_container_labels_traefik_media_enabled: true +matrix_bridge_zulip_container_labels_traefik_media_hostname: "{{ matrix_bridge_zulip_container_labels_traefik_hostname }}" +# The path prefix must either be `/` or not end with a slash (e.g. `/zulip`). +matrix_bridge_zulip_container_labels_traefik_media_path_prefix: "{{ '' if matrix_bridge_zulip_container_labels_traefik_path_prefix == '/' else (matrix_bridge_zulip_container_labels_traefik_path_prefix) }}/_bridge_zulip/media" +matrix_bridge_zulip_container_labels_traefik_media_rule: "Host(`{{ matrix_bridge_zulip_container_labels_traefik_media_hostname }}`){% if matrix_bridge_zulip_container_labels_traefik_media_path_prefix != '/' %} && PathPrefix(`{{ matrix_bridge_zulip_container_labels_traefik_media_path_prefix }}`){% endif %}" +matrix_bridge_zulip_container_labels_traefik_media_priority: 0 +matrix_bridge_zulip_container_labels_traefik_media_entrypoints: "{{ matrix_bridge_zulip_container_labels_traefik_entrypoints }}" +matrix_bridge_zulip_container_labels_traefik_media_tls: "{{ matrix_bridge_zulip_container_labels_traefik_media_entrypoints != 'web' }}" +matrix_bridge_zulip_container_labels_traefik_media_tls_certResolver: "{{ matrix_bridge_zulip_container_labels_traefik_tls_certResolver }}" # noqa var-naming + +# matrix_bridge_zulip_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_bridge_zulip_container_labels_additional_labels: | +# my.label=1 +# another.label="here" +matrix_bridge_zulip_container_labels_additional_labels: '' + +# A list of extra arguments to pass to the container +matrix_bridge_zulip_container_extra_arguments: [] + +# List of systemd services that service depends on. +matrix_bridge_zulip_systemd_required_services_list: "{{ matrix_bridge_zulip_systemd_required_services_list_default + matrix_bridge_zulip_systemd_required_services_list_auto + matrix_bridge_zulip_systemd_required_services_list_custom }}" +matrix_bridge_zulip_systemd_required_services_list_default: "{{ [devture_systemd_docker_base_docker_service_name] if devture_systemd_docker_base_docker_service_name else [] }}" +matrix_bridge_zulip_systemd_required_services_list_auto: [] +matrix_bridge_zulip_systemd_required_services_list_custom: [] + +# List of systemd services that service wants +matrix_bridge_zulip_systemd_wanted_services_list: [] + +matrix_bridge_zulip_homeserver_url: "" + +matrix_bridge_zulip_appservice_token: '' +matrix_bridge_zulip_homeserver_token: '' + +matrix_bridge_zulip_config_media_url: "{{ matrix_bridge_zulip_scheme }}://{{ matrix_bridge_zulip_hostname }}" +# This matches the hardcoded `DEFAULT_MEDIA_PATH` in MatrixZulipBridge, but uses `matrix_bridge_zulip_path_prefix` as the path prefix. +# See: https://github.com/GearKite/MatrixZulipBridge/blob/2ba51f3da2ad8bd33460c953ef91a9cfc585a2d4/matrixzulipbridge/__main__.py#L87 +matrix_bridge_zulip_config_media_path: "{{ matrix_bridge_zulip_container_labels_traefik_media_path_prefix }}/v3/download/{netloc}{path}{filename}" +matrix_bridge_zulip_config_media_key: "{{ matrix_bridge_zulip_homeserver_token }}" +matrix_bridge_zulip_config_displayname: "MatrixZulipBridge" + +matrix_bridge_zulip_registration_yaml_bridge_zulip: + media_url: "{{ matrix_bridge_zulip_config_media_url }}" + media_path: "{{ matrix_bridge_zulip_config_media_path }}" + media_key: "{{ matrix_bridge_zulip_config_media_key }}" + displayname: "{{ matrix_bridge_zulip_config_displayname }}" + +# Default registration file consumed by both the homeserver and MatrixZulipBridge. +# Besides registration information, it contains configuration (see the MatrixZulipBridge key). +matrix_bridge_zulip_registration_yaml: + id: zulipbridge + url: http://matrix-bridge-zulip:{{ matrix_bridge_zulip_container_http_port }} + as_token: "{{ matrix_bridge_zulip_appservice_token }}" + hs_token: "{{ matrix_bridge_zulip_homeserver_token }}" + rate_limited: false + sender_localpart: zulipbridge + namespaces: + users: + - regex: '@zulip_.*' + exclusive: true + aliases: [] + rooms: [] + matrixzulipbridge: "{{ matrix_bridge_zulip_registration_yaml_bridge_zulip }}" + +matrix_bridge_zulip_registration: "{{ matrix_bridge_zulip_registration_yaml | from_yaml }}" diff --git a/roles/custom/matrix-bridge-matrixzulipbridge/tasks/main.yml b/roles/custom/matrix-bridge-zulip/tasks/main.yml similarity index 81% rename from roles/custom/matrix-bridge-matrixzulipbridge/tasks/main.yml rename to roles/custom/matrix-bridge-zulip/tasks/main.yml index c132de96c..bc95b380d 100644 --- a/roles/custom/matrix-bridge-matrixzulipbridge/tasks/main.yml +++ b/roles/custom/matrix-bridge-zulip/tasks/main.yml @@ -7,12 +7,12 @@ --- - name: Perform MatrixZulipBridge installation tasks - when: matrixzulipbridge_enabled | bool + when: matrix_bridge_zulip_enabled | bool tags: - setup-all - - setup-matrixzulipbridge + - setup-bridge-zulip - install-all - - install-matrixzulipbridge + - install-bridge-zulip block: - name: Validate MatrixZulipBridge configuration ansible.builtin.include_tasks: "{{ role_path }}/tasks/validate_config.yml" @@ -20,10 +20,10 @@ ansible.builtin.include_tasks: "{{ role_path }}/tasks/setup_install.yml" - name: Perform MatrixZulipBridge uninstallation tasks - when: not matrixzulipbridge_enabled | bool + when: not matrix_bridge_zulip_enabled | bool tags: - setup-all - - setup-matrixzulipbridge + - setup-bridge-zulip block: - name: Uninstall MatrixZulipBridge ansible.builtin.include_tasks: "{{ role_path }}/tasks/setup_uninstall.yml" diff --git a/roles/custom/matrix-bridge-matrixzulipbridge/tasks/setup_install.yml b/roles/custom/matrix-bridge-zulip/tasks/setup_install.yml similarity index 70% rename from roles/custom/matrix-bridge-matrixzulipbridge/tasks/setup_install.yml rename to roles/custom/matrix-bridge-zulip/tasks/setup_install.yml index 6d4f9c9db..c3a9c2bff 100644 --- a/roles/custom/matrix-bridge-matrixzulipbridge/tasks/setup_install.yml +++ b/roles/custom/matrix-bridge-zulip/tasks/setup_install.yml @@ -11,10 +11,10 @@ --- - name: Ensure MatrixZulipBridge image is pulled community.docker.docker_image: - name: "{{ matrix_matrixzulipbridge_docker_image }}" + name: "{{ matrix_bridge_zulip_docker_image }}" source: "{{ 'pull' if ansible_version.major > 2 or ansible_version.minor > 7 else omit }}" - force_source: "{{ matrix_matrixzulipbridge_docker_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_matrixzulipbridge_docker_image_force_pull }}" + force_source: "{{ matrix_bridge_zulip_docker_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_bridge_zulip_docker_image_force_pull }}" register: result retries: "{{ devture_playbook_help_container_retries_count }}" delay: "{{ devture_playbook_help_container_retries_delay }}" @@ -28,12 +28,12 @@ owner: "{{ matrix_user_name }}" group: "{{ matrix_group_name }}" with_items: - - "{{ matrix_matrixzulipbridge_base_path }}" + - "{{ matrix_bridge_zulip_base_path }}" - name: Ensure MatrixZulipBridge registration.yaml installed if provided ansible.builtin.copy: - content: "{{ matrix_matrixzulipbridge_registration | to_nice_yaml(indent=2, width=999999) }}" - dest: "{{ matrix_matrixzulipbridge_base_path }}/registration.yaml" + content: "{{ matrix_bridge_zulip_registration | to_nice_yaml(indent=2, width=999999) }}" + dest: "{{ matrix_bridge_zulip_base_path }}/registration.yaml" mode: "0644" owner: "{{ matrix_user_name }}" group: "{{ matrix_group_name }}" @@ -41,7 +41,7 @@ - name: Ensure MatrixZulipBridge support files installed ansible.builtin.template: src: "{{ role_path }}/templates/{{ item }}.j2" - dest: "{{ matrix_matrixzulipbridge_base_path }}/{{ item }}" + dest: "{{ matrix_bridge_zulip_base_path }}/{{ item }}" mode: "0640" owner: "{{ matrix_user_name }}" group: "{{ matrix_group_name }}" @@ -51,12 +51,12 @@ - name: Ensure MatrixZulipBridge container network is created community.general.docker_network: enable_ipv6: "{{ devture_systemd_docker_base_ipv6_enabled }}" - name: "{{ matrix_matrixzulipbridge_container_network }}" + name: "{{ matrix_bridge_zulip_container_network }}" driver: bridge driver_options: "{{ devture_systemd_docker_base_container_networks_driver_options }}" -- name: Ensure matrix-matrixzulipbridge.service installed +- name: Ensure matrix-bridge-zulip.service installed ansible.builtin.template: - src: "{{ role_path }}/templates/systemd/matrix-matrixzulipbridge.service.j2" - dest: "{{ devture_systemd_docker_base_systemd_path }}/matrix-matrixzulipbridge.service" + src: "{{ role_path }}/templates/systemd/matrix-bridge-zulip.service.j2" + dest: "{{ devture_systemd_docker_base_systemd_path }}/matrix-bridge-zulip.service" mode: "0644" diff --git a/roles/custom/matrix-bridge-matrixzulipbridge/tasks/setup_uninstall.yml b/roles/custom/matrix-bridge-zulip/tasks/setup_uninstall.yml similarity index 58% rename from roles/custom/matrix-bridge-matrixzulipbridge/tasks/setup_uninstall.yml rename to roles/custom/matrix-bridge-zulip/tasks/setup_uninstall.yml index bfb53034a..abbc991fb 100644 --- a/roles/custom/matrix-bridge-matrixzulipbridge/tasks/setup_uninstall.yml +++ b/roles/custom/matrix-bridge-zulip/tasks/setup_uninstall.yml @@ -6,21 +6,21 @@ # SPDX-License-Identifier: AGPL-3.0-or-later --- -- name: Check existence of matrix-matrixzulipbridge service +- name: Check existence of matrix-bridge-zulip service ansible.builtin.stat: - path: "{{ devture_systemd_docker_base_systemd_path }}/matrix-matrixzulipbridge.service" - register: matrix_matrixzulipbridge_service_stat + path: "{{ devture_systemd_docker_base_systemd_path }}/matrix-bridge-zulip.service" + register: matrix_bridge_zulip_service_stat -- when: matrix_matrixzulipbridge_service_stat.stat.exists | bool +- when: matrix_bridge_zulip_service_stat.stat.exists | bool block: - - name: Ensure matrix-matrixzulipbridge is stopped + - name: Ensure matrix-bridge-zulip is stopped ansible.builtin.service: - name: matrix-matrixzulipbridge + name: matrix-bridge-zulip state: stopped enabled: false daemon_reload: true - - name: Ensure matrix-matrixzulipbridge.service doesn't exist + - name: Ensure matrix-bridge-zulip.service doesn't exist ansible.builtin.file: - path: "{{ devture_systemd_docker_base_systemd_path }}/matrix-matrixzulipbridge.service" + path: "{{ devture_systemd_docker_base_systemd_path }}/matrix-bridge-zulip.service" state: absent diff --git a/roles/custom/matrix-bridge-matrixzulipbridge/tasks/validate_config.yml b/roles/custom/matrix-bridge-zulip/tasks/validate_config.yml similarity index 75% rename from roles/custom/matrix-bridge-matrixzulipbridge/tasks/validate_config.yml rename to roles/custom/matrix-bridge-zulip/tasks/validate_config.yml index b72aab2fa..69fb61196 100644 --- a/roles/custom/matrix-bridge-matrixzulipbridge/tasks/validate_config.yml +++ b/roles/custom/matrix-bridge-zulip/tasks/validate_config.yml @@ -10,5 +10,5 @@ You need to define a required configuration setting (`{{ item.name }}`). when: "item.when | bool and lookup('vars', item.name, default='') | string | length == 0" with_items: - - {"name": "matrix_matrixzulipbridge_container_network", when: true} - - {"name": "matrix_matrixzulipbridge_homeserver_url", when: true} + - {"name": "matrix_bridge_zulip_container_network", when: true} + - {"name": "matrix_bridge_zulip_homeserver_url", when: true} diff --git a/roles/custom/matrix-bridge-zulip/templates/labels.j2 b/roles/custom/matrix-bridge-zulip/templates/labels.j2 new file mode 100644 index 000000000..6fbf1f6f2 --- /dev/null +++ b/roles/custom/matrix-bridge-zulip/templates/labels.j2 @@ -0,0 +1,58 @@ +{# +SPDX-FileCopyrightText: 2024 Slavi Pantaleev + +SPDX-License-Identifier: AGPL-3.0-or-later +#} + +{% if matrix_bridge_zulip_container_labels_traefik_enabled %} +traefik.enable=true + +{% if matrix_bridge_zulip_container_labels_traefik_docker_network %} +traefik.docker.network={{ matrix_bridge_zulip_container_labels_traefik_docker_network }} +{% endif %} + +traefik.http.services.matrix-bridge-zulip.loadbalancer.server.port={{ matrix_bridge_zulip_container_http_port }} + +{% set middlewares = [] %} + +{% if matrix_bridge_zulip_container_labels_traefik_path_prefix != '/' %} +traefik.http.middlewares.matrix-bridge-zulip-strip-prefix.stripprefix.prefixes={{ matrix_bridge_zulip_container_labels_traefik_path_prefix }} +{% set middlewares = middlewares + ['matrix-bridge-zulip-strip-prefix'] %} +{% endif %} + +{% if matrix_bridge_zulip_container_labels_traefik_media_enabled %} +########################################################################## +# # +# Media # +# # +########################################################################## + +traefik.http.routers.matrix-bridge-zulip-media.rule={{ matrix_bridge_zulip_container_labels_traefik_media_rule }} + +{% if matrix_bridge_zulip_container_labels_traefik_media_priority | int > 0 %} +traefik.http.routers.matrix-bridge-zulip-media.priority={{ matrix_bridge_zulip_container_labels_traefik_media_priority }} +{% endif %} + +{% if middlewares | length > 0 %} +traefik.http.routers.matrix-bridge-zulip-media.middlewares={{ middlewares | join(',') }} +{% endif %} + +traefik.http.routers.matrix-bridge-zulip-media.service=matrix-bridge-zulip +traefik.http.routers.matrix-bridge-zulip-media.entrypoints={{ matrix_bridge_zulip_container_labels_traefik_entrypoints }} + +traefik.http.routers.matrix-bridge-zulip-media.tls={{ matrix_bridge_zulip_container_labels_traefik_media_tls | to_json }} +{% if matrix_bridge_zulip_container_labels_traefik_media_entrypoints %} +traefik.http.routers.matrix-bridge-zulip-media.tls.certResolver={{ matrix_bridge_zulip_container_labels_traefik_media_tls_certResolver }} +{% endif %} + +########################################################################## +# # +# /Media # +# # +########################################################################## +{% endif %} + + +{% endif %} + +{{ matrix_bridge_zulip_container_labels_additional_labels }} diff --git a/roles/custom/matrix-bridge-matrixzulipbridge/templates/systemd/matrix-matrixzulipbridge.service.j2 b/roles/custom/matrix-bridge-zulip/templates/systemd/matrix-matrixzulipbridge.service.j2 similarity index 50% rename from roles/custom/matrix-bridge-matrixzulipbridge/templates/systemd/matrix-matrixzulipbridge.service.j2 rename to roles/custom/matrix-bridge-zulip/templates/systemd/matrix-matrixzulipbridge.service.j2 index dafa5a8cf..c605716f7 100644 --- a/roles/custom/matrix-bridge-matrixzulipbridge/templates/systemd/matrix-matrixzulipbridge.service.j2 +++ b/roles/custom/matrix-bridge-zulip/templates/systemd/matrix-matrixzulipbridge.service.j2 @@ -8,11 +8,11 @@ SPDX-License-Identifier: AGPL-3.0-or-later [Unit] Description=a puppeting appservice bridge for Zulip -{% for service in matrix_matrixzulipbridge_systemd_required_services_list %} +{% for service in matrix_bridge_zulip_systemd_required_services_list %} Requires={{ service }} After={{ service }} {% endfor %} -{% for service in matrix_matrixzulipbridge_systemd_wanted_services_list %} +{% for service in matrix_bridge_zulip_systemd_wanted_services_list %} Wants={{ service }} {% endfor %} DefaultDependencies=no @@ -20,41 +20,41 @@ DefaultDependencies=no [Service] Type=simple Environment="HOME={{ devture_systemd_docker_base_systemd_unit_home_path }}" -ExecStartPre=-{{ devture_systemd_docker_base_host_command_docker }} stop -t {{ matrix_matrixzulipbridge_container_stop_grace_time_seconds }} matrix-matrixzulipbridge -ExecStartPre=-{{ devture_systemd_docker_base_host_command_docker }} rm matrix-matrixzulipbridge +ExecStartPre=-{{ devture_systemd_docker_base_host_command_docker }} stop -t {{ matrix_bridge_zulip_container_stop_grace_time_seconds }} matrix-bridge-zulip +ExecStartPre=-{{ devture_systemd_docker_base_host_command_docker }} rm matrix-bridge-zulip ExecStartPre={{ devture_systemd_docker_base_host_command_docker }} create \ --rm \ - --name=matrix-matrixzulipbridge \ + --name=matrix-bridge-zulip \ --log-driver=none \ --user={{ matrix_user_uid }}:{{ matrix_user_gid }} \ --cap-drop=ALL \ - --network={{ matrix_matrixzulipbridge_container_network }} \ - --mount type=bind,src={{ matrix_matrixzulipbridge_base_path }},dst=/config \ - --label-file={{ matrix_matrixzulipbridge_base_path }}/labels \ - {% for arg in matrix_matrixzulipbridge_container_extra_arguments %} + --network={{ matrix_bridge_zulip_container_network }} \ + --mount type=bind,src={{ matrix_bridge_zulip_base_path }},dst=/config \ + --label-file={{ matrix_bridge_zulip_base_path }}/labels \ + {% for arg in matrix_bridge_zulip_container_extra_arguments %} {{ arg }} \ {% endfor %} - {{ matrix_matrixzulipbridge_docker_image }} \ - {% if matrix_matrixzulipbridge_owner %} - -o {{ matrix_matrixzulipbridge_owner }} \ + {{ matrix_bridge_zulip_docker_image }} \ + {% if matrix_bridge_zulip_owner %} + -o {{ matrix_bridge_zulip_owner }} \ {% endif %} --config /config/registration.yaml \ --listen-address 0.0.0.0 \ - --listen-port {{ matrix_matrixzulipbridge_container_http_port }} \ - {{ matrix_matrixzulipbridge_homeserver_url }} + --listen-port {{ matrix_bridge_zulip_container_http_port }} \ + {{ matrix_bridge_zulip_homeserver_url }} -{% for network in matrix_matrixzulipbridge_container_additional_networks %} -ExecStartPre={{ devture_systemd_docker_base_host_command_docker }} network connect {{ network }} matrix-matrixzulipbridge +{% for network in matrix_bridge_zulip_container_additional_networks %} +ExecStartPre={{ devture_systemd_docker_base_host_command_docker }} network connect {{ network }} matrix-bridge-zulip {% endfor %} -ExecStart={{ devture_systemd_docker_base_host_command_docker }} start --attach matrix-matrixzulipbridge +ExecStart={{ devture_systemd_docker_base_host_command_docker }} start --attach matrix-bridge-zulip -ExecStop=-{{ devture_systemd_docker_base_host_command_docker }} stop -t {{ matrix_matrixzulipbridge_container_stop_grace_time_seconds }} matrix-matrixzulipbridge -ExecStop=-{{ devture_systemd_docker_base_host_command_docker }} rm matrix-matrixzulipbridge +ExecStop=-{{ devture_systemd_docker_base_host_command_docker }} stop -t {{ matrix_bridge_zulip_container_stop_grace_time_seconds }} matrix-bridge-zulip +ExecStop=-{{ devture_systemd_docker_base_host_command_docker }} rm matrix-bridge-zulip Restart=always RestartSec=30 -SyslogIdentifier=matrix-matrixzulipbridge +SyslogIdentifier=matrix-bridge-zulip [Install] WantedBy=multi-user.target diff --git a/setup.yml b/setup.yml index 7b23ee66c..fc9080906 100644 --- a/setup.yml +++ b/setup.yml @@ -87,7 +87,7 @@ - custom/matrix-bridge-steam - custom/matrix-bridge-heisenbridge - custom/matrix-bridge-hookshot - - custom/matrix-bridge-matrixzulipbridge + - custom/matrix-bridge-zulip - custom/matrix-bot-matrix-reminder-bot - custom/matrix-bot-matrix-registration-bot - custom/matrix-bot-maubot