Replace "matrixzulipbridge" with "zulip", etc.

Signed-off-by: Suguru Hirahara <did:key:z6MkvVZk1A3KBApWJXv2Ju4H14ErDfRGxh8zxdXSZ4vACDg5>

Author: Suguru Hirahara

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-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) |

…ing-playbook-bridge-matrixzulipbridge.md docs/configuring-playbook-bridge-zulip.mddocs/configuring-playbook-bridge-matrixzulipbridge.md renamed to docs/configuring-playbook-bridge-zulip.md docs/configuring-playbook-bridge-matrixzulipbridge.md renamed to 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`.

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-bridge-zulip.md)
 
 - [Setting up Heisenbridge bouncer-style IRC bridging](configuring-playbook-bridge-heisenbridge.md)
 

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-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) |

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)+'$',