matrix-docker-ansible-deploy/docs/configuring-playbook-bridge-heisenbridge.md

# Setting up Heisenbridge (optional)

**Note**: bridging to [IRC](https://en.wikipedia.org/wiki/Internet_Relay_Chat) can also happen via the [matrix-appservice-irc](configuring-playbook-bridge-appservice-irc.md) bridge supported by the playbook.

The playbook can install and configure [Heisenbridge](https://github.com/hifi/heisenbridge) - the bouncer-style [IRC](https://en.wikipedia.org/wiki/Internet_Relay_Chat) bridge for you.

See the project's [README](https://github.com/hifi/heisenbridge/blob/master/README.md) to learn what it does and why it might be useful to you. You can also take a look at [this demonstration video](https://www.youtube.com/watch?v=nQk1Bp4tk4I).

## Configuration

Below are the common configuration options that you may want to set, exhaustive list is in [the bridge's defaults var file](../roles/custom/matrix-bridge-heisenbridge/defaults/main.yml).

At a minimum, you only need to enable the bridge to get it up and running (`inventory/host_vars/matrix.DOMAIN/vars.yml`):

```yaml
matrix_heisenbridge_enabled: true

# set owner (optional)
matrix_heisenbridge_owner: "@you:your-homeserver"

# to enable identd on host port 113/TCP (optional)
matrix_heisenbridge_identd_enabled: true
```

By default, Heisenbrdige would be exposed on the Matrix domain (`matrix.DOMAIN`, as specified in `matrix_server_fqn_matrix`) under the `/heisenbridge` path prefix. It would handle media requests there (see the [release notes for Heisenbridge v1.15.0](https://github.com/hifi/heisenbridge/releases/tag/v1.15.0)).

That's it! A registration file is automatically generated during the setup phase.

Setting the owner is optional as the first local user to DM `@heisenbridge:your-homeserver` 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.

## Usage

After the bridge is successfully running just DM `@heisenbridge:your-homeserver` to start setting it up.
Help is available for all commands with the `-h` switch.
If the bridge ignores you and a DM is not accepted then the owner setting may be wrong.

You can also learn the basics by watching [this demonstration video](https://www.youtube.com/watch?v=nQk1Bp4tk4I).

If you encounter issues or feel lost you can join the project room at [#heisenbridge:vi.fi](https://matrix.to/#/#heisenbridge:vi.fi) for help.
Add Heisenbridge 2021-05-12 15:24:39 +03:00			`# Setting up Heisenbridge (optional)`

Cross-link similar bridges 2021-05-19 13:32:05 +03:00			`Note: bridging to [IRC](https://en.wikipedia.org/wiki/Internet_Relay_Chat) can also happen via the [matrix-appservice-irc](configuring-playbook-bridge-appservice-irc.md) bridge supported by the playbook.`

			`The playbook can install and configure [Heisenbridge](https://github.com/hifi/heisenbridge) - the bouncer-style [IRC](https://en.wikipedia.org/wiki/Internet_Relay_Chat) bridge for you.`
Add Heisenbridge 2021-05-12 15:24:39 +03:00
Link to Heisenbridge demonstration video 2021-06-04 09:32:22 +03:00			`See the project's [README](https://github.com/hifi/heisenbridge/blob/master/README.md) to learn what it does and why it might be useful to you. You can also take a look at [this demonstration video](https://www.youtube.com/watch?v=nQk1Bp4tk4I).`
Add Heisenbridge 2021-05-12 15:24:39 +03:00
			`## Configuration`

Move roles/matrix* to roles/custom/matrix* This paves the way for installing other roles into `roles/galaxy` using `ansible-galaxy`, similar to how it's done in: - https://github.com/spantaleev/gitea-docker-ansible-deploy - https://github.com/spantaleev/nextcloud-docker-ansible-deploy In the near future, we'll be removing a lot of the shared role code from here and using upstream roles for it. Some of the core `matrix-*` roles have already been extracted out into other reusable roles: - https://github.com/devture/com.devture.ansible.role.postgres - https://github.com/devture/com.devture.ansible.role.systemd_docker_base - https://github.com/devture/com.devture.ansible.role.timesync - https://github.com/devture/com.devture.ansible.role.vars_preserver - https://github.com/devture/com.devture.ansible.role.playbook_runtime_messages - https://github.com/devture/com.devture.ansible.role.playbook_help We just need to migrate to those. 2022-11-03 09:11:29 +02:00			`Below are the common configuration options that you may want to set, exhaustive list is in [the bridge's defaults var file](../roles/custom/matrix-bridge-heisenbridge/defaults/main.yml).`
Add Heisenbridge 2021-05-12 15:24:39 +03:00
			At a minimum, you only need to enable the bridge to get it up and running (`inventory/host_vars/matrix.DOMAIN/vars.yml`):

			```yaml
			`matrix_heisenbridge_enabled: true`

			`# set owner (optional)`
			`matrix_heisenbridge_owner: "@you:your-homeserver"`

			`# to enable identd on host port 113/TCP (optional)`
			`matrix_heisenbridge_identd_enabled: true`
			```

Initial (not yet enabled) work on Heisenbridge handling media requests at `matrix.DOMAIN/heisenbridge/*` Related to: - https://github.com/spantaleev/matrix-docker-ansible-deploy/pull/3470 - https://github.com/hifi/heisenbridge/releases/tag/v1.15.0 During testing, it appears that Heisenbridge generated media URLs that look like this: `{media_url}/_matrix/media/v3/download/DOMAIN/FILE_ID/FILE_NAME`. This seems off. We were expecting `{media_url}/_heisenbridge/media/something` (e.g. `https://matrix.DOMAIN/heisenbridge/_heisenbridge/media/something`, leading to its own media proxy), but Heisenbridge still seems to be generating URLs destined for the homeserver's Media API. Until we figure out why that is, `media_url` remains pointed to the homeserver URL (just like before), so that the bot can continue operating like before. 2024-08-10 06:22:59 +03:00			By default, Heisenbrdige would be exposed on the Matrix domain (`matrix.DOMAIN`, as specified in `matrix_server_fqn_matrix`) under the `/heisenbridge` path prefix. It would handle media requests there (see the [release notes for Heisenbridge v1.15.0](https://github.com/hifi/heisenbridge/releases/tag/v1.15.0)).

Add Heisenbridge 2021-05-12 15:24:39 +03:00			`That's it! A registration file is automatically generated during the setup phase.`

			Setting the owner is optional as the first local user to DM `@heisenbridge:your-homeserver` 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.`

			`## Usage`

			After the bridge is successfully running just DM `@heisenbridge:your-homeserver` to start setting it up.
			Help is available for all commands with the `-h` switch.
			`If the bridge ignores you and a DM is not accepted then the owner setting may be wrong.`

Link to Heisenbridge demonstration video 2021-06-04 09:32:22 +03:00			`You can also learn the basics by watching [this demonstration video](https://www.youtube.com/watch?v=nQk1Bp4tk4I).`

Add Heisenbridge 2021-05-12 15:24:39 +03:00			`If you encounter issues or feel lost you can join the project room at [#heisenbridge:vi.fi](https://matrix.to/#/#heisenbridge:vi.fi) for help.`