2.4 KiB
Setting up Heisenbridge (optional)
Note: bridging to IRC can also happen via the matrix-appservice-irc bridge supported by the playbook.
The playbook can install and configure Heisenbridge - the bouncer-style IRC bridge for you.
See the project's README to learn what it does and why it might be useful to you. You can also take a look at this demonstration video.
Configuration
Below are the common configuration options that you may want to set, exhaustive list is in the bridge's defaults var file.
At a minimum, you only need to enable the bridge to get it up and running (inventory/host_vars/matrix.example.com/vars.yml):
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.example.com, 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).
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.
Installing
After configuring the playbook, run the installation command: just install-all or just setup-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.
If you encounter issues or feel lost you can join the project room at #heisenbridge:vi.fi for help.