From d6b8c40c8d21b83c0a4831a2d5c50e61f5f37c2b Mon Sep 17 00:00:00 2001 From: Oliver Lorenz Date: Mon, 30 Sep 2024 13:28:47 +0200 Subject: [PATCH] Adds Matterbridge service (#218) * adds matterbridge service * repair docs * Install Mattebridge role from the MASH organization --------- Co-authored-by: Oliver Lorenz Co-authored-by: Slavi Pantaleev --- docs/services/matterbridge.md | 48 +++++++++++++++++++++++++++++++++++ docs/supported-services.md | 1 + templates/requirements.yml | 6 +++++ templates/setup.yml | 4 +++ 4 files changed, 59 insertions(+) create mode 100644 docs/services/matterbridge.md diff --git a/docs/services/matterbridge.md b/docs/services/matterbridge.md new file mode 100644 index 0000000..a314af0 --- /dev/null +++ b/docs/services/matterbridge.md @@ -0,0 +1,48 @@ +# Matterbridge + +[Matterbridge](https://github.com/42wim/matterbridge) + +## Configuration + +To enable this service, add the following configuration to your `vars.yml` file and re-run the [installation](../installing.md) process: + +The configuration itself is documented [here](https://github.com/42wim/matterbridge/wiki/How-to-create-your-config) + +```yaml +######################################################################## +# # +# matterbridge # +# # +######################################################################## + +matterbridge_enabled: true +matterbridge_configuration_toml: + accounts: + - protocol: matrix + identifier: someidentifier + configuration: + Server: "https://matrix.example.com" + Login: "{{ matterbridge_matrix_user }}" + Password: "{{ matterbridge_matrix_password }}" + RemoteNickFormat: "{NICK}: " + NoHomeServerSuffix: "false" + + gateways: + - name: "A Gateway" + enable: "true" + channels: + + - type: inout + account: matrix.someidentifier + channel: "!roomA:matrix.example.com" + + - type: inout + account: matrix.freifunk + channel: "!roomB:matrix.example.com" + +######################################################################## +# # +# /matterbridge # +# # +######################################################################## +``` diff --git a/docs/supported-services.md b/docs/supported-services.md index 3ecd465..acd3ed7 100644 --- a/docs/supported-services.md +++ b/docs/supported-services.md @@ -45,6 +45,7 @@ | [languageTool](https://languagetool.org/) | An open source online grammar, style and spell checker | [Link](services/languagetool.md) | | [linkding](https://github.com/sissbruecker/linkding/) | Bookmark manager designed to be minimal and fast. | [Link](services/linkding.md) | | [MariaDB](https://mariadb.org/) | A powerful, open source object-relational database system | [Link](services/mariadb.md) | +| [Matterbridge](https://github.com/42wim/matterbridge) | Bridges Messanger Chatrooms | [Link](services/matterbridge.md) | | [Matrix Rooms Search API](https://gitlab.com/etke.cc/mrs/api) | A fully-featured, standalone, matrix rooms search service. | [Link](services/mrs.md) | | [MongoDB](https://www.mongodb.com/) | A source-available cross-platform document-oriented (NoSQL) database program. | [Link](services/mongodb.md) | | [Mosquitto](https://mosquitto.org/) | An open-source MQTT broker | [Link](services/mosquitto.md) | diff --git a/templates/requirements.yml b/templates/requirements.yml index f7f45c2..1bd6e18 100644 --- a/templates/requirements.yml +++ b/templates/requirements.yml @@ -196,6 +196,12 @@ version: v11.4.3-0 name: mariadb activation_prefix: mariadb_ +- src: git+https://github.com/mother-of-all-self-hosting/ansible-role-matterbridge.git + version: v1.26.0-0 + name: matterbridge + activation_prefix: matterbridge_ +- src: git+https://gitlab.com/etke.cc/roles/miniflux.git + version: v2.1.4-0 - src: git+https://github.com/mother-of-all-self-hosting/ansible-role-miniflux.git version: v2.2.0-0 name: miniflux diff --git a/templates/setup.yml b/templates/setup.yml index 277481d..a45ffe8 100644 --- a/templates/setup.yml +++ b/templates/setup.yml @@ -447,6 +447,10 @@ - role: galaxy/auxiliary # /role-specific:auxiliary + # role-specific:matterbridge + - role: galaxy/matterbridge + # /role-specific:matterbridge + # role-specific:systemd_service_manager - when: devture_systemd_service_manager_enabled | bool role: galaxy/systemd_service_manager