From f3154d303611f3763a4a8513704f2ebca256ef9f Mon Sep 17 00:00:00 2001 From: Suguru Hirahara Date: Sun, 2 Nov 2025 23:39:55 +0900 Subject: [PATCH] Add configuring-playbook-bridge-matrixzulipbridge.md Reuse https://github.com/spantaleev/matrix-docker-ansible-deploy/blob/b108c8a15165cebe346c7b16cbe181a495db6bf7/docs/configuring-playbook-bridge-heisenbridge.md Signed-off-by: Suguru Hirahara --- .codespellrc | 2 +- ...uring-playbook-bridge-matrixzulipbridge.md | 81 +++++++++++++++++++ 2 files changed, 82 insertions(+), 1 deletion(-) create mode 100644 docs/configuring-playbook-bridge-matrixzulipbridge.md diff --git a/.codespellrc b/.codespellrc index 83ec2578c..1c1da2564 100644 --- a/.codespellrc +++ b/.codespellrc @@ -1,2 +1,2 @@ [codespell] -ignore-words-list = aNULL,brose,doub,Udo,re-use,re-used,registr +ignore-words-list = aNULL,brose,doub,Udo,re-use,re-used,registr,shema diff --git a/docs/configuring-playbook-bridge-matrixzulipbridge.md b/docs/configuring-playbook-bridge-matrixzulipbridge.md new file mode 100644 index 000000000..0fdd42ac7 --- /dev/null +++ b/docs/configuring-playbook-bridge-matrixzulipbridge.md @@ -0,0 +1,81 @@ + + +# Setting up MatrixZulipBridge (optional) + +The playbook can install and configure [MatrixZulipBridge](https://github.com/GearKite/MatrixZulipBridge) for you. + +See the project's [documentation](https://github.com/GearKite/MatrixZulipBridge/blob/main/README.md) to learn what it does and why it might be useful to you. + +## 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. + +If you wish to adjust it, see the section [below](#adjusting-the-matrixzulipbridge-url-optional) for details about DNS configuration. + +## Adjusting the playbook configuration + +To enable MatrixZulipBridge, add the following configuration to your `inventory/host_vars/matrix.example.com/vars.yml` file: + +```yaml +matrix_matrixzulipbridge_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 }}" + +# Uncomment to enable identd on host port 113/TCP (optional) +# matrix_matrixzulipbridge_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. + +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: / +``` + +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`. + +When setting, replace `example.com` with your own. + +### Extending the configuration + +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 + +## Installing + +After configuring the playbook and potentially [adjusting your DNS records](#adjusting-dns-records), run the playbook with [playbook tags](playbook-tags.md) as below: + + +```sh +ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start +``` + +The shortcut commands with the [`just` program](just.md) are also available: `just install-all` or `just setup-all` + +`just install-all` is useful for maintaining your setup quickly ([2x-5x faster](../CHANGELOG.md#2x-5x-performance-improvements-in-playbook-runtime) than `just setup-all`) when its components remain unchanged. If you adjust your `vars.yml` to remove other components, you'd need to run `just setup-all`, or these components will still remain installed. Note these shortcuts run the `ensure-matrix-users-created` tag too. + +## 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. + +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`.