Note that files in docs/assets/ are managed with REUSE.toml Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>pull/3859/head
| @@ -4,6 +4,11 @@ | |||||
| version = 1 | version = 1 | ||||
| [[annotations]] | |||||
| path = "docs/assets/*" | |||||
| SPDX-FileCopyrightText = "2024 MDAD Team and contributors" | |||||
| SPDX-License-Identifier = "AGPL-3.0-or-later" | |||||
| # Computer-generated files | # Computer-generated files | ||||
| [[annotations]] | [[annotations]] | ||||
| path = [ | path = [ | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Table of Contents | # Table of Contents | ||||
| ## ⬇️ Installaton guides <!-- NOTE: the 🚀 emoji is used by "Getting started" on README.md --> | ## ⬇️ Installaton guides <!-- NOTE: the 🚀 emoji is used by "Getting started" on README.md --> | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Alternative architectures | # Alternative architectures | ||||
| As stated in the [Prerequisites](prerequisites.md), currently only `amd64` (`x86_64`) is fully supported. | As stated in the [Prerequisites](prerequisites.md), currently only `amd64` (`x86_64`) is fully supported. | ||||
| @@ -1,3 +1,8 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Running this playbook | # Running this playbook | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| (Adapted from the [upstream project](https://github.com/element-hq/synapse/blob/develop/docs/CAPTCHA_SETUP.md)) | (Adapted from the [upstream project](https://github.com/element-hq/synapse/blob/develop/docs/CAPTCHA_SETUP.md)) | ||||
| # Overview | # Overview | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Configuring your DNS settings | # Configuring your DNS settings | ||||
| <sup>[Prerequisites](prerequisites.md) > Configuring your DNS settings > [Getting the playbook](getting-the-playbook.md) > [Configuring the playbook](configuring-playbook.md) > [Installing](installing.md)</sup> | <sup>[Prerequisites](prerequisites.md) > Configuring your DNS settings > [Getting the playbook](getting-the-playbook.md) > [Configuring the playbook](configuring-playbook.md) > [Installing](installing.md)</sup> | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Setting up Prometheus Alertmanager integration via matrix-alertmanager-receiver (optional) | # Setting up Prometheus Alertmanager integration via matrix-alertmanager-receiver (optional) | ||||
| The playbook can install and configure the [matrix-alertmanager-receiver](https://github.com/metio/matrix-alertmanager-receiver) service for you. It's a [client](https://prometheus.io/docs/alerting/latest/clients/) for Prometheus' [Alertmanager](https://prometheus.io/docs/alerting/latest/alertmanager/), allowing you to deliver alerts to Matrix rooms. | The playbook can install and configure the [matrix-alertmanager-receiver](https://github.com/metio/matrix-alertmanager-receiver) service for you. It's a [client](https://prometheus.io/docs/alerting/latest/clients/) for Prometheus' [Alertmanager](https://prometheus.io/docs/alerting/latest/alertmanager/), allowing you to deliver alerts to Matrix rooms. | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Setting up Appservice Double Puppet (optional) | # Setting up Appservice Double Puppet (optional) | ||||
| Appservice Double Puppet is a homeserver appservice through which bridges (and potentially other services) can impersonate any user on the homeserver. | Appservice Double Puppet is a homeserver appservice through which bridges (and potentially other services) can impersonate any user on the homeserver. | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Setting up Draupnir for All/D4A (optional) | # Setting up Draupnir for All/D4A (optional) | ||||
| The playbook can install and configure the [Draupnir](https://github.com/the-draupnir-project/Draupnir) moderation tool for you in appservice mode. | The playbook can install and configure the [Draupnir](https://github.com/the-draupnir-project/Draupnir) moderation tool for you in appservice mode. | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Setting up BorgBackup (optional) | # Setting up BorgBackup (optional) | ||||
| The playbook can install and configure [BorgBackup](https://www.borgbackup.org/) (short: Borg) with [borgmatic](https://torsion.org/borgmatic/) for you. | The playbook can install and configure [BorgBackup](https://www.borgbackup.org/) (short: Borg) with [borgmatic](https://torsion.org/borgmatic/) for you. | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Serving the base domain (optional) | # Serving the base domain (optional) | ||||
| By default, this playbook sets up services on your Matrix server (`matrix.example.com`), but has it configured so that it presents itself as the base domain (`example.com`). To have this server officially be responsible for Matrix services for the base domain (`example.com`), you need to set up server delegation / redirection. | By default, this playbook sets up services on your Matrix server (`matrix.example.com`), but has it configured so that it presents itself as the base domain (`example.com`). To have this server officially be responsible for Matrix services for the base domain (`example.com`), you need to set up server delegation / redirection. | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Setting up baibot (optional) | # Setting up baibot (optional) | ||||
| <p align="center"> | <p align="center"> | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Setting up Buscarron (optional) | # Setting up Buscarron (optional) | ||||
| The playbook can install and configure [Buscarron](https://github.com/etkecc/buscarron) for you. | The playbook can install and configure [Buscarron](https://github.com/etkecc/buscarron) for you. | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Setting up matrix-bot-chatgpt (optional, unmaintained) | # Setting up matrix-bot-chatgpt (optional, unmaintained) | ||||
| **Note**: [matrix-chatgpt-bot](https://github.com/matrixgpt/matrix-chatgpt-bot) is now an archived (**unmaintained**) project. Talking to ChatGPT (and many other LLM providers) can happen via the much more featureful [baibot](https://github.com/etkecc/baibot), which can be installed using [this playbook](configuring-playbook-bot-baibot.md). Consider using that bot instead of this one. | **Note**: [matrix-chatgpt-bot](https://github.com/matrixgpt/matrix-chatgpt-bot) is now an archived (**unmaintained**) project. Talking to ChatGPT (and many other LLM providers) can happen via the much more featureful [baibot](https://github.com/etkecc/baibot), which can be installed using [this playbook](configuring-playbook-bot-baibot.md). Consider using that bot instead of this one. | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Setting up Draupnir (optional) | # Setting up Draupnir (optional) | ||||
| The playbook can install and configure the [Draupnir](https://github.com/the-draupnir-project/Draupnir) moderation bot for you. | The playbook can install and configure the [Draupnir](https://github.com/the-draupnir-project/Draupnir) moderation bot for you. | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Setting up Go-NEB (optional, unmaintained) | # Setting up Go-NEB (optional, unmaintained) | ||||
| **Note**: [Go-NEB](https://github.com/matrix-org/go-neb) is now an archived (**unmaintained**) project. We recommend not bothering with installing it. While not a 1:1 replacement, the bridge's author suggests taking a look at [matrix-hookshot](https://github.com/matrix-org/matrix-hookshot) as a replacement, which can also be installed using [this playbook](configuring-playbook-bridge-hookshot.md). Consider using that bot instead of this one. | **Note**: [Go-NEB](https://github.com/matrix-org/go-neb) is now an archived (**unmaintained**) project. We recommend not bothering with installing it. While not a 1:1 replacement, the bridge's author suggests taking a look at [matrix-hookshot](https://github.com/matrix-org/matrix-hookshot) as a replacement, which can also be installed using [this playbook](configuring-playbook-bridge-hookshot.md). Consider using that bot instead of this one. | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Setting up Honoroit (optional) | # Setting up Honoroit (optional) | ||||
| The playbook can install and configure [Honoroit](https://github.com/etkecc/honoroit) for you. | The playbook can install and configure [Honoroit](https://github.com/etkecc/honoroit) for you. | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Setting up matrix-registration-bot (optional) | # Setting up matrix-registration-bot (optional) | ||||
| The playbook can install and configure [matrix-registration-bot](https://github.com/moan0s/matrix-registration-bot) for you. | The playbook can install and configure [matrix-registration-bot](https://github.com/moan0s/matrix-registration-bot) for you. | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Setting up matrix-reminder-bot (optional) | # Setting up matrix-reminder-bot (optional) | ||||
| The playbook can install and configure [matrix-reminder-bot](https://github.com/anoadragon453/matrix-reminder-bot) for you. | The playbook can install and configure [matrix-reminder-bot](https://github.com/anoadragon453/matrix-reminder-bot) for you. | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Setting up maubot (optional) | # Setting up maubot (optional) | ||||
| The playbook can install and configure [maubot](https://github.com/maubot/maubot) for you. | The playbook can install and configure [maubot](https://github.com/maubot/maubot) for you. | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Setting up Mjolnir (optional) | # Setting up Mjolnir (optional) | ||||
| The playbook can install and configure the [Mjolnir](https://github.com/matrix-org/mjolnir) moderation bot for you. | The playbook can install and configure the [Mjolnir](https://github.com/matrix-org/mjolnir) moderation bot for you. | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Setting up Appservice Discord bridging (optional) | # Setting up Appservice Discord bridging (optional) | ||||
| **Note**: bridging to [Discord](https://discordapp.com/) can also happen via the [mx-puppet-discord](configuring-playbook-bridge-mx-puppet-discord.md) and [mautrix-discord](configuring-playbook-bridge-mautrix-discord.md) bridges supported by the playbook. | **Note**: bridging to [Discord](https://discordapp.com/) can also happen via the [mx-puppet-discord](configuring-playbook-bridge-mx-puppet-discord.md) and [mautrix-discord](configuring-playbook-bridge-mautrix-discord.md) bridges supported by the playbook. | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Setting up Appservice IRC bridging (optional) | # Setting up Appservice IRC bridging (optional) | ||||
| **Note**: bridging to [IRC](https://en.wikipedia.org/wiki/Internet_Relay_Chat) can also happen via the [Heisenbridge](configuring-playbook-bridge-heisenbridge.md) bridge supported by the playbook. | **Note**: bridging to [IRC](https://en.wikipedia.org/wiki/Internet_Relay_Chat) can also happen via the [Heisenbridge](configuring-playbook-bridge-heisenbridge.md) bridge supported by the playbook. | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Setting up Appservice Kakaotalk bridging (optional) | # Setting up Appservice Kakaotalk bridging (optional) | ||||
| The playbook can install and configure [matrix-appservice-kakaotalk](https://src.miscworks.net/fair/matrix-appservice-kakaotalk) for you. `matrix-appservice-kakaotalk` is a bridge to [Kakaotalk](https://www.kakaocorp.com/page/service/service/KakaoTalk?lang=ENG) based on [node-kakao](https://github.com/storycraft/node-kakao) (now unmaintained) and some [mautrix-facebook](https://github.com/mautrix/facebook) code. | The playbook can install and configure [matrix-appservice-kakaotalk](https://src.miscworks.net/fair/matrix-appservice-kakaotalk) for you. `matrix-appservice-kakaotalk` is a bridge to [Kakaotalk](https://www.kakaocorp.com/page/service/service/KakaoTalk?lang=ENG) based on [node-kakao](https://github.com/storycraft/node-kakao) (now unmaintained) and some [mautrix-facebook](https://github.com/mautrix/facebook) code. | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Setting up Appservice Slack bridging (optional) | # Setting up Appservice Slack bridging (optional) | ||||
| **Notes**: | **Notes**: | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Setting up Appservice Webhooks bridging (optional, deprecated) | # Setting up Appservice Webhooks bridging (optional, deprecated) | ||||
| **Note**: This bridge has been deprecated. We recommend not bothering with installing it. While not a 1:1 replacement, the bridge's author suggests taking a look at [matrix-hookshot](https://github.com/matrix-org/matrix-hookshot) as a replacement, which can also be installed using [this playbook](configuring-playbook-bridge-hookshot.md). Consider using that bridge instead of this one. | **Note**: This bridge has been deprecated. We recommend not bothering with installing it. While not a 1:1 replacement, the bridge's author suggests taking a look at [matrix-hookshot](https://github.com/matrix-org/matrix-hookshot) as a replacement, which can also be installed using [this playbook](configuring-playbook-bridge-hookshot.md). Consider using that bridge instead of this one. | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Setting up Beeper Linkedin bridging (optional) | # Setting up Beeper Linkedin bridging (optional) | ||||
| The playbook can install and configure [beeper-linkedin](https://github.com/beeper/linkedin) for you, for bridging to [LinkedIn](https://www.linkedin.com/) Messaging. This bridge is based on the mautrix-python framework and can be configured in a similar way to the other mautrix bridges | The playbook can install and configure [beeper-linkedin](https://github.com/beeper/linkedin) for you, for bridging to [LinkedIn](https://www.linkedin.com/) Messaging. This bridge is based on the mautrix-python framework and can be configured in a similar way to the other mautrix bridges | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Setting up Go Skype Bridge bridging (optional) | # Setting up Go Skype Bridge bridging (optional) | ||||
| The playbook can install and configure [go-skype-bridge](https://github.com/kelaresg/go-skype-bridge) for you. | The playbook can install and configure [go-skype-bridge](https://github.com/kelaresg/go-skype-bridge) for you. | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Setting up Heisenbridge bouncer-style IRC bridging (optional) | # Setting up Heisenbridge bouncer-style IRC bridging (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. | **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. | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Setting up matrix-hookshot (optional) | # Setting up matrix-hookshot (optional) | ||||
| The playbook can install and configure [matrix-hookshot](https://github.com/matrix-org/matrix-hookshot) for you. | The playbook can install and configure [matrix-hookshot](https://github.com/matrix-org/matrix-hookshot) for you. | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Setting up Matrix SMS bridging (optional) | # Setting up Matrix SMS bridging (optional) | ||||
| The playbook can install and configure [matrix-sms-bridge](https://github.com/benkuly/matrix-sms-bridge) for you. | The playbook can install and configure [matrix-sms-bridge](https://github.com/benkuly/matrix-sms-bridge) for you. | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Setting up Mautrix Discord bridging (optional) | # Setting up Mautrix Discord bridging (optional) | ||||
| **Note**: bridging to [Discord](https://discordapp.com/) can also happen via the [mx-puppet-discord](configuring-playbook-bridge-mx-puppet-discord.md) and [matrix-appservice-discord](configuring-playbook-bridge-appservice-discord.md) bridges supported by the playbook. | **Note**: bridging to [Discord](https://discordapp.com/) can also happen via the [mx-puppet-discord](configuring-playbook-bridge-mx-puppet-discord.md) and [matrix-appservice-discord](configuring-playbook-bridge-appservice-discord.md) bridges supported by the playbook. | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Setting up Mautrix Facebook bridging (optional, deprecated) | # Setting up Mautrix Facebook bridging (optional, deprecated) | ||||
| **Note**: This bridge has been deprecated in favor of the [mautrix-meta](https://github.com/mautrix/meta) Messenger/Instagram bridge, which can be installed using [this playbook](configuring-playbook-bridge-mautrix-meta-messenger.md). Consider using that bridge instead of this one. | **Note**: This bridge has been deprecated in favor of the [mautrix-meta](https://github.com/mautrix/meta) Messenger/Instagram bridge, which can be installed using [this playbook](configuring-playbook-bridge-mautrix-meta-messenger.md). Consider using that bridge instead of this one. | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Setting up Mautrix Google Messages bridging (optional) | # Setting up Mautrix Google Messages bridging (optional) | ||||
| The playbook can install and configure [mautrix-gmessages](https://github.com/mautrix/gmessages) for you, for bridging to [Google Messages](https://messages.google.com/). | The playbook can install and configure [mautrix-gmessages](https://github.com/mautrix/gmessages) for you, for bridging to [Google Messages](https://messages.google.com/). | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Setting up Mautrix Google Chat bridging (optional) | # Setting up Mautrix Google Chat bridging (optional) | ||||
| The playbook can install and configure [mautrix-googlechat](https://github.com/mautrix/googlechat) for you. | The playbook can install and configure [mautrix-googlechat](https://github.com/mautrix/googlechat) for you. | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Setting up Mautrix Hangouts bridging (optional, deprecated) | # Setting up Mautrix Hangouts bridging (optional, deprecated) | ||||
| **Note**: This bridge has been deprecated in favor of [Google Chat bridge](https://github.com/mautrix/googlechat), which can be installed using [this playbook](configuring-playbook-bridge-mautrix-googlechat.md). Consider using that bridge instead of this one. | **Note**: This bridge has been deprecated in favor of [Google Chat bridge](https://github.com/mautrix/googlechat), which can be installed using [this playbook](configuring-playbook-bridge-mautrix-googlechat.md). Consider using that bridge instead of this one. | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Setting up Mautrix Instagram bridging (optional, deprecated) | # Setting up Mautrix Instagram bridging (optional, deprecated) | ||||
| **Note**: This bridge has been deprecated in favor of the [mautrix-meta](https://github.com/mautrix/meta) Messenger/Instagram bridge, which can be installed using [this playbook](configuring-playbook-bridge-mautrix-meta-instagram.md). Consider using that bridge instead of this one. | **Note**: This bridge has been deprecated in favor of the [mautrix-meta](https://github.com/mautrix/meta) Messenger/Instagram bridge, which can be installed using [this playbook](configuring-playbook-bridge-mautrix-meta-instagram.md). Consider using that bridge instead of this one. | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Setting up Instagram bridging via Mautrix Meta (optional) | # Setting up Instagram bridging via Mautrix Meta (optional) | ||||
| The playbook can install and configure the [mautrix-meta](https://github.com/mautrix/meta) Messenger/Instagram bridge for you. | The playbook can install and configure the [mautrix-meta](https://github.com/mautrix/meta) Messenger/Instagram bridge for you. | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Setting up Messenger bridging via Mautrix Meta (optional) | # Setting up Messenger bridging via Mautrix Meta (optional) | ||||
| The playbook can install and configure the [mautrix-meta](https://github.com/mautrix/meta) Messenger/Instagram bridge for you. | The playbook can install and configure the [mautrix-meta](https://github.com/mautrix/meta) Messenger/Instagram bridge for you. | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Setting up Mautrix Signal bridging (optional) | # Setting up Mautrix Signal bridging (optional) | ||||
| The playbook can install and configure [mautrix-signal](https://github.com/mautrix/signal) for you. | The playbook can install and configure [mautrix-signal](https://github.com/mautrix/signal) for you. | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Setting up Mautrix Slack bridging (optional) | # Setting up Mautrix Slack bridging (optional) | ||||
| **Note**: bridging to [Slack](https://slack.com/) can also happen via the [mx-puppet-slack](configuring-playbook-bridge-mx-puppet-slack.md) and [matrix-appservice-slack](configuring-playbook-bridge-appservice-slack.md) bridges supported by the playbook. | **Note**: bridging to [Slack](https://slack.com/) can also happen via the [mx-puppet-slack](configuring-playbook-bridge-mx-puppet-slack.md) and [matrix-appservice-slack](configuring-playbook-bridge-appservice-slack.md) bridges supported by the playbook. | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Setting up Mautrix Telegram bridging (optional) | # Setting up Mautrix Telegram bridging (optional) | ||||
| The playbook can install and configure [mautrix-telegram](https://github.com/mautrix/telegram) for you. | The playbook can install and configure [mautrix-telegram](https://github.com/mautrix/telegram) for you. | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Setting up Mautrix Twitter bridging (optional) | # Setting up Mautrix Twitter bridging (optional) | ||||
| **Note**: bridging to [Twitter](https://twitter.com/) can also happen via the [mx-puppet-twitter](configuring-playbook-bridge-mx-puppet-twitter.md) bridge supported by the playbook. | **Note**: bridging to [Twitter](https://twitter.com/) can also happen via the [mx-puppet-twitter](configuring-playbook-bridge-mx-puppet-twitter.md) bridge supported by the playbook. | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Setting up Mautrix Whatsapp bridging (optional) | # Setting up Mautrix Whatsapp bridging (optional) | ||||
| The playbook can install and configure [mautrix-whatsapp](https://github.com/mautrix/whatsapp) for you. | The playbook can install and configure [mautrix-whatsapp](https://github.com/mautrix/whatsapp) for you. | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Setting up Mautrix wsproxy for bridging Android SMS or Apple iMessage (optional) | # Setting up Mautrix wsproxy for bridging Android SMS or Apple iMessage (optional) | ||||
| The playbook can install and configure [mautrix-wsproxy](https://github.com/mautrix/wsproxy) for you. | The playbook can install and configure [mautrix-wsproxy](https://github.com/mautrix/wsproxy) for you. | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Setting up MX Puppet Discord bridging (optional) | # Setting up MX Puppet Discord bridging (optional) | ||||
| **Note**: bridging to [Discord](https://discordapp.com/) can also happen via the [matrix-appservice-discord](configuring-playbook-bridge-appservice-discord.md)and [mautrix-discord](configuring-playbook-bridge-mautrix-discord.md) bridges supported by the playbook. | **Note**: bridging to [Discord](https://discordapp.com/) can also happen via the [matrix-appservice-discord](configuring-playbook-bridge-appservice-discord.md)and [mautrix-discord](configuring-playbook-bridge-mautrix-discord.md) bridges supported by the playbook. | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Setting up MX Puppet GroupMe bridging (optional) | # Setting up MX Puppet GroupMe bridging (optional) | ||||
| The playbook can install and configure [mx-puppet-groupme](https://gitlab.com/xangelix-pub/matrix/mx-puppet-groupme) for you. | The playbook can install and configure [mx-puppet-groupme](https://gitlab.com/xangelix-pub/matrix/mx-puppet-groupme) for you. | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Setting up MX Puppet Instagram bridging (optional) | # Setting up MX Puppet Instagram bridging (optional) | ||||
| The playbook can install and configure [mx-puppet-instagram](https://github.com/Sorunome/mx-puppet-instagram) for you. | The playbook can install and configure [mx-puppet-instagram](https://github.com/Sorunome/mx-puppet-instagram) for you. | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Setting up MX Puppet Skype bridging (optional, removed) | # Setting up MX Puppet Skype bridging (optional, removed) | ||||
| The playbook used to be able to install and configure [mx-puppet-skype](https://github.com/Sorunome/mx-puppet-skype), but no longer includes this component, because it has been broken and unmaintained for a long time. | The playbook used to be able to install and configure [mx-puppet-skype](https://github.com/Sorunome/mx-puppet-skype), but no longer includes this component, because it has been broken and unmaintained for a long time. | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Setting up MX Puppet Slack bridging (optional) | # Setting up MX Puppet Slack bridging (optional) | ||||
| **Note**: bridging to [Slack](https://slack.com) can also happen via the [matrix-appservice-slack](configuring-playbook-bridge-appservice-slack.md) and [mautrix-slack](configuring-playbook-bridge-mautrix-slack.md) bridges supported by the playbook. Note that `matrix-appservice-slack` is not available for new installation unless you have already created a classic Slack application, because the creation of classic Slack applications, which this bridge makes use of, has been discontinued. | **Note**: bridging to [Slack](https://slack.com) can also happen via the [matrix-appservice-slack](configuring-playbook-bridge-appservice-slack.md) and [mautrix-slack](configuring-playbook-bridge-mautrix-slack.md) bridges supported by the playbook. Note that `matrix-appservice-slack` is not available for new installation unless you have already created a classic Slack application, because the creation of classic Slack applications, which this bridge makes use of, has been discontinued. | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Setting up MX Puppet Steam bridging (optional) | # Setting up MX Puppet Steam bridging (optional) | ||||
| The playbook can install and configure [mx-puppet-steam](https://github.com/icewind1991/mx-puppet-steam) for you. | The playbook can install and configure [mx-puppet-steam](https://github.com/icewind1991/mx-puppet-steam) for you. | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Setting up MX Puppet Twitter bridging (optional) | # Setting up MX Puppet Twitter bridging (optional) | ||||
| **Note**: bridging to [Twitter](https://twitter.com/) can also happen via the [mautrix-twitter](configuring-playbook-bridge-mautrix-twitter.md) bridge supported by the playbook. | **Note**: bridging to [Twitter](https://twitter.com/) can also happen via the [mautrix-twitter](configuring-playbook-bridge-mautrix-twitter.md) bridge supported by the playbook. | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Setting up Postmoogle email bridging (optional) | # Setting up Postmoogle email bridging (optional) | ||||
| **Note**: email bridging can also happen via the [email2matrix](configuring-playbook-email2matrix.md) bridge supported by the playbook. | **Note**: email bridging can also happen via the [email2matrix](configuring-playbook-email2matrix.md) bridge supported by the playbook. | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Setting up WeChat bridging (optional) | # Setting up WeChat bridging (optional) | ||||
| The playbook can install and configure the [matrix-wechat](https://github.com/duo/matrix-wechat) bridge for you (for bridging to the [WeChat](https://www.wechat.com/) network). | The playbook can install and configure the [matrix-wechat](https://github.com/duo/matrix-wechat) bridge for you (for bridging to the [WeChat](https://www.wechat.com/) network). | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Setting up Cactus Comments (optional) | # Setting up Cactus Comments (optional) | ||||
| The playbook can install and configure the [Cactus Comments](https://cactus.chat) system for you. | The playbook can install and configure the [Cactus Comments](https://cactus.chat) system for you. | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Setting up Cinny (optional) | # Setting up Cinny (optional) | ||||
| This playbook can install the [Cinny](https://github.com/ajbura/cinny) Matrix web client for you. | This playbook can install the [Cinny](https://github.com/ajbura/cinny) Matrix web client for you. | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Configuring Element Web (optional) | # Configuring Element Web (optional) | ||||
| By default, this playbook installs the [Element Web](https://github.com/element-hq/element-web) Matrix client for you. If that's okay, you can skip this document. | By default, this playbook installs the [Element Web](https://github.com/element-hq/element-web) Matrix client for you. If that's okay, you can skip this document. | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Setting up Hydrogen (optional) | # Setting up Hydrogen (optional) | ||||
| This playbook can install the [Hydrogen](https://github.com/element-hq/hydrogen-web) Matrix web client for you. | This playbook can install the [Hydrogen](https://github.com/element-hq/hydrogen-web) Matrix web client for you. | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Setting up SchildiChat Web (optional) | # Setting up SchildiChat Web (optional) | ||||
| This playbook can install the [SchildiChat Web](https://github.com/SchildiChat/schildichat-desktop) Matrix client for you. | This playbook can install the [SchildiChat Web](https://github.com/SchildiChat/schildichat-desktop) Matrix client for you. | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Configuring Conduit (optional) | # Configuring Conduit (optional) | ||||
| By default, this playbook configures the [Synapse](https://github.com/element-hq/synapse) Matrix server, but you can also use [Conduit](https://conduit.rs). | By default, this playbook configures the [Synapse](https://github.com/element-hq/synapse) Matrix server, but you can also use [Conduit](https://conduit.rs). | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Configuring Dendrite (optional) | # Configuring Dendrite (optional) | ||||
| By default, this playbook configures the [Synapse](https://github.com/element-hq/synapse) Matrix server, but you can also use [Dendrite](https://github.com/matrix-org/dendrite). | By default, this playbook configures the [Synapse](https://github.com/element-hq/synapse) Matrix server, but you can also use [Dendrite](https://github.com/matrix-org/dendrite). | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Setting up Dimension integration manager (optional, unmaintained) | # Setting up Dimension integration manager (optional, unmaintained) | ||||
| **[Dimension](https://dimension.t2bot.io) can only be installed after Matrix services are installed and running.** If you're just installing Matrix services for the first time, please continue with the [Configuration](configuring-playbook.md) / [Installation](installing.md) flow and come back here later. | **[Dimension](https://dimension.t2bot.io) can only be installed after Matrix services are installed and running.** If you're just installing Matrix services for the first time, please continue with the [Configuration](configuring-playbook.md) / [Installation](installing.md) flow and come back here later. | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Setting up Dynamic DNS (optional) | # Setting up Dynamic DNS (optional) | ||||
| The playbook can configure Dynamic DNS with [ddclient](https://github.com/ddclient/ddclient) for you. It is a Perl client used to update dynamic DNS entries for accounts on Dynamic DNS Network Service Provider. | The playbook can configure Dynamic DNS with [ddclient](https://github.com/ddclient/ddclient) for you. It is a Perl client used to update dynamic DNS entries for accounts on Dynamic DNS Network Service Provider. | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Adjusting email-sending settings (optional) | # Adjusting email-sending settings (optional) | ||||
| By default, this playbook sets up an [Exim](https://www.exim.org/) email server through which all Matrix services send emails. | By default, this playbook sets up an [Exim](https://www.exim.org/) email server through which all Matrix services send emails. | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Setting up Email2Matrix (optional) | # Setting up Email2Matrix (optional) | ||||
| **Note**: email bridging can also happen via the [Postmoogle](configuring-playbook-bridge-postmoogle.md) bridge supported by the playbook. Postmoogle is much more powerful and easier to use, so we recommend that you use it, instead of Email2Matrix. | **Note**: email bridging can also happen via the [Postmoogle](configuring-playbook-bridge-postmoogle.md) bridge supported by the playbook. Postmoogle is much more powerful and easier to use, so we recommend that you use it, instead of Email2Matrix. | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Setting up Etherpad (optional) | # Setting up Etherpad (optional) | ||||
| [Etherpad](https://etherpad.org) is an open source collaborative text editor that can be embedded in a Matrix chat room using the [Dimension integration manager](https://dimension.t2bot.io) or used as standalone web app. | [Etherpad](https://etherpad.org) is an open source collaborative text editor that can be embedded in a Matrix chat room using the [Dimension integration manager](https://dimension.t2bot.io) or used as standalone web app. | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Using an external PostgreSQL server (optional) | # Using an external PostgreSQL server (optional) | ||||
| By default, this playbook would set up a PostgreSQL database server on your machine, running in a Docker container. If that's okay, you can skip this document. | By default, this playbook would set up a PostgreSQL database server on your machine, running in a Docker container. If that's okay, you can skip this document. | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Controlling Matrix federation (optional) | # Controlling Matrix federation (optional) | ||||
| By default, your server federates with the whole Matrix network. That is, people on your server can communicate with people on any other Matrix server. | By default, your server federates with the whole Matrix network. That is, people on your server can communicate with people on any other Matrix server. | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Setting up the Jitsi video-conferencing platform (optional) | # Setting up the Jitsi video-conferencing platform (optional) | ||||
| The playbook can install the [Jitsi](https://jitsi.org/) video-conferencing platform and integrate it with Element clients ([Element Web](configuring-playbook-client-element-web.md)/Desktop, Android and iOS). | The playbook can install the [Jitsi](https://jitsi.org/) video-conferencing platform and integrate it with Element clients ([Element Web](configuring-playbook-client-element-web.md)/Desktop, Android and iOS). | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Setting up the LDAP authentication password provider module (optional, advanced) | # Setting up the LDAP authentication password provider module (optional, advanced) | ||||
| The playbook can install and configure the [matrix-synapse-ldap3](https://github.com/matrix-org/matrix-synapse-ldap3) LDAP Auth password provider for you. | The playbook can install and configure the [matrix-synapse-ldap3](https://github.com/matrix-org/matrix-synapse-ldap3) LDAP Auth password provider for you. | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Setting up ma1sd Identity Server (optional) | # Setting up ma1sd Identity Server (optional) | ||||
| **⚠️Note**: ma1sd itself has also been unmaintained for years (the latest commit and release being from 2021). The role of identity servers in the Matrix specification also has an uncertain future. **We recommend not bothering with installing it unless it's the only way you can do what you need to do**. For example, certain things like LDAP integration can also be implemented via [the LDAP provider module for Synapse](./configuring-playbook-ldap-auth.md). | **⚠️Note**: ma1sd itself has also been unmaintained for years (the latest commit and release being from 2021). The role of identity servers in the Matrix specification also has an uncertain future. **We recommend not bothering with installing it unless it's the only way you can do what you need to do**. For example, certain things like LDAP integration can also be implemented via [the LDAP provider module for Synapse](./configuring-playbook-ldap-auth.md). | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Setting up Matrix Authentication Service (optional) | # Setting up Matrix Authentication Service (optional) | ||||
| This playbook can install and configure [Matrix Authentication Service](https://github.com/element-hq/matrix-authentication-service/) (MAS) - a service operating alongside your existing [Synapse](./configuring-playbook-synapse.md) homeserver and providing [better authentication, session management and permissions in Matrix](https://matrix.org/blog/2023/09/better-auth/). | This playbook can install and configure [Matrix Authentication Service](https://github.com/element-hq/matrix-authentication-service/) (MAS) - a service operating alongside your existing [Synapse](./configuring-playbook-synapse.md) homeserver and providing [better authentication, session management and permissions in Matrix](https://matrix.org/blog/2023/09/better-auth/). | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Setting up Matrix Corporal (optional, advanced) | # Setting up Matrix Corporal (optional, advanced) | ||||
| ------------------------------------- | ------------------------------------- | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Setting up matrix-ldap-registration-proxy (optional) | # Setting up matrix-ldap-registration-proxy (optional) | ||||
| The playbook can install and configure [matrix-ldap-registration-proxy](https://gitlab.com/activism.international/matrix_ldap_registration_proxy) for you. | The playbook can install and configure [matrix-ldap-registration-proxy](https://gitlab.com/activism.international/matrix_ldap_registration_proxy) for you. | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Storing Matrix media files using matrix-media-repo (optional) | # Storing Matrix media files using matrix-media-repo (optional) | ||||
| [matrix-media-repo](https://docs.t2bot.io/matrix-media-repo/) (often abbreviated "MMR") is a highly customizable multi-domain media repository for Matrix. Intended for medium to large environments consisting of several homeservers, this media repo de-duplicates media (including remote media) while being fully compliant with the specification. | [matrix-media-repo](https://docs.t2bot.io/matrix-media-repo/) (often abbreviated "MMR") is a highly customizable multi-domain media repository for Matrix. Intended for medium to large environments consisting of several homeservers, this media repo de-duplicates media (including remote media) while being fully compliant with the specification. | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Setting up matrix-registration (optional) | # Setting up matrix-registration (optional) | ||||
| The playbook can install and configure [matrix-registration](https://github.com/ZerataX/matrix-registration) for you. | The playbook can install and configure [matrix-registration](https://github.com/ZerataX/matrix-registration) for you. | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Setting up a Generic Mautrix Bridge (optional) | # Setting up a Generic Mautrix Bridge (optional) | ||||
| The playbook can install and configure various [mautrix](https://github.com/mautrix) bridges (twitter, facebook, instagram, signal, hangouts, googlechat, etc.), as well as many other (non-mautrix) bridges. This is a common guide for configuring mautrix bridges. | The playbook can install and configure various [mautrix](https://github.com/mautrix) bridges (twitter, facebook, instagram, signal, hangouts, googlechat, etc.), as well as many other (non-mautrix) bridges. This is a common guide for configuring mautrix bridges. | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Configure Nginx (optional, advanced) | # Configure Nginx (optional, advanced) | ||||
| Since 2024-01, this playbook no longer uses nginx as its reverse-proxy. | Since 2024-01, this playbook no longer uses nginx as its reverse-proxy. | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Setting up the ntfy push notifications server (optional) | # Setting up the ntfy push notifications server (optional) | ||||
| The playbook can install and configure the [ntfy](https://ntfy.sh/) push notifications server for you. | The playbook can install and configure the [ntfy](https://ntfy.sh/) push notifications server for you. | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Using your own webserver, instead of this playbook's Traefik reverse-proxy (optional, advanced) | # Using your own webserver, instead of this playbook's Traefik reverse-proxy (optional, advanced) | ||||
| By default, this playbook installs its own [Traefik](https://traefik.io/) reverse-proxy server (in a Docker container) which listens on ports 80 and 443. If that's okay, you can skip this document. | By default, this playbook installs its own [Traefik](https://traefik.io/) reverse-proxy server (in a Docker container) which listens on ports 80 and 443. If that's okay, you can skip this document. | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Setting up Pantalaimon (E2EE aware proxy daemon) (optional) | # Setting up Pantalaimon (E2EE aware proxy daemon) (optional) | ||||
| The playbook can install and configure the [pantalaimon](https://github.com/matrix-org/pantalaimon) E2EE aware proxy daemon for you. | The playbook can install and configure the [pantalaimon](https://github.com/matrix-org/pantalaimon) E2EE aware proxy daemon for you. | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Setting up postgres backup (optional) | # Setting up postgres backup (optional) | ||||
| The playbook can install and configure [docker-postgres-backup-local](https://github.com/prodrigestivill/docker-postgres-backup-local) for you via the [ansible-role-postgres-backup](https://github.com/mother-of-all-self-hosting/ansible-role-postgres-backup) Ansible role. | The playbook can install and configure [docker-postgres-backup-local](https://github.com/prodrigestivill/docker-postgres-backup-local) for you via the [ansible-role-postgres-backup](https://github.com/mother-of-all-self-hosting/ansible-role-postgres-backup) Ansible role. | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Enabling metrics and graphs (Prometheus, Grafana) for your Matrix server (optional) | # Enabling metrics and graphs (Prometheus, Grafana) for your Matrix server (optional) | ||||
| The playbook can install [Grafana](https://grafana.com/) with [Prometheus](https://prometheus.io/) and configure performance metrics of your homeserver with graphs for you. | The playbook can install [Grafana](https://grafana.com/) with [Prometheus](https://prometheus.io/) and configure performance metrics of your homeserver with graphs for you. | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Enabling metrics and graphs for NginX logs (optional) | # Enabling metrics and graphs for NginX logs (optional) | ||||
| It can be useful to have some (visual) insight into [nginx](https://nginx.org/) logs. | It can be useful to have some (visual) insight into [nginx](https://nginx.org/) logs. | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Enabling metrics and graphs for Postgres (optional) | # Enabling metrics and graphs for Postgres (optional) | ||||
| Expanding on the metrics exposed by the [synapse exporter and the node exporter](configuring-playbook-prometheus-grafana.md), the playbook enables the [postgres exporter](https://github.com/prometheus-community/postgres_exporter) that exposes more detailed information about what's happening on your postgres database. | Expanding on the metrics exposed by the [synapse exporter and the node exporter](configuring-playbook-prometheus-grafana.md), the playbook enables the [postgres exporter](https://github.com/prometheus-community/postgres_exporter) that exposes more detailed information about what's happening on your postgres database. | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Setting up the rageshake bug report server (optional) | # Setting up the rageshake bug report server (optional) | ||||
| The playbook can install and configure the [rageshake](https://github.com/matrix-org/rageshake) bug report server for you. | The playbook can install and configure the [rageshake](https://github.com/matrix-org/rageshake) bug report server for you. | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Setting up the REST authentication password provider module (optional, advanced) | # Setting up the REST authentication password provider module (optional, advanced) | ||||
| The playbook can install and configure [matrix-synapse-rest-auth](https://github.com/ma1uta/matrix-synapse-rest-password-provider) for you. | The playbook can install and configure [matrix-synapse-rest-auth](https://github.com/ma1uta/matrix-synapse-rest-password-provider) for you. | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Configuring Riot-web (optional) | # Configuring Riot-web (optional) | ||||
| By default, this playbook **used to install** the [Riot-web](https://github.com/element-hq/riot-web) Matrix client web application. | By default, this playbook **used to install** the [Riot-web](https://github.com/element-hq/riot-web) Matrix client web application. | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Storing Matrix media files on Amazon S3 with Goofys (optional) | # Storing Matrix media files on Amazon S3 with Goofys (optional) | ||||
| If you'd like to store Synapse's content repository (`media_store`) files on Amazon S3 (or other S3-compatible service), you can let this playbook configure [Goofys](https://github.com/kahing/goofys) for you. | If you'd like to store Synapse's content repository (`media_store`) files on Amazon S3 (or other S3-compatible service), you can let this playbook configure [Goofys](https://github.com/kahing/goofys) for you. | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Storing Synapse media files on Amazon S3 or another compatible Object Storage (optional) | # Storing Synapse media files on Amazon S3 or another compatible Object Storage (optional) | ||||
| By default, this playbook configures your server to store Synapse's content repository (`media_store`) files on the local filesystem. If that's okay, you can skip this document. | By default, this playbook configures your server to store Synapse's content repository (`media_store`) files on the local filesystem. If that's okay, you can skip this document. | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Setting up the Shared Secret Auth password provider module (optional, advanced) | # Setting up the Shared Secret Auth password provider module (optional, advanced) | ||||
| The playbook can install and configure [matrix-synapse-shared-secret-auth](https://github.com/devture/matrix-synapse-shared-secret-auth) for you. | The playbook can install and configure [matrix-synapse-shared-secret-auth](https://github.com/devture/matrix-synapse-shared-secret-auth) for you. | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Setting up the Sliding Sync proxy (optional) | # Setting up the Sliding Sync proxy (optional) | ||||
| **Note**: The sliding-sync proxy is **not required** anymore as it's been replaced with a different method (called Simplified Sliding Sync) which is integrated into newer homeservers by default (**Conduit** homeserver from version `0.6.0` or **Synapse** from version `1.114`). This component and documentation remain here for historical purposes, but **installing this old sliding-sync proxy is generally not recommended anymore**. | **Note**: The sliding-sync proxy is **not required** anymore as it's been replaced with a different method (called Simplified Sliding Sync) which is integrated into newer homeservers by default (**Conduit** homeserver from version `0.6.0` or **Synapse** from version `1.114`). This component and documentation remain here for historical purposes, but **installing this old sliding-sync proxy is generally not recommended anymore**. | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Adjusting SSL certificate retrieval (optional, advanced) | # Adjusting SSL certificate retrieval (optional, advanced) | ||||
| By default, this playbook retrieves and auto-renews free SSL certificates from [Let's Encrypt](https://letsencrypt.org/) for the domains it needs (e.g. `matrix.example.com` and others) | By default, this playbook retrieves and auto-renews free SSL certificates from [Let's Encrypt](https://letsencrypt.org/) for the domains it needs (e.g. `matrix.example.com` and others) | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Setting up the Sygnal push gateway (optional) | # Setting up the Sygnal push gateway (optional) | ||||
| The playbook can install and configure the [Sygnal](https://github.com/matrix-org/sygnal) push gateway for you. | The playbook can install and configure the [Sygnal](https://github.com/matrix-org/sygnal) push gateway for you. | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Setting up Synapse Admin (optional) | # Setting up Synapse Admin (optional) | ||||
| The playbook can install and configure [etkecc/synapse-admin](https://github.com/etkecc/synapse-admin) (a [feature-rich](https://github.com/etkecc/synapse-admin#fork-differences) fork of [Awesome-Technologies/synapse-admin](https://github.com/Awesome-Technologies/synapse-admin), community room: [#synapse-admin:etke.cc](https://matrix.to/#/#synapse-admin:etke.cc)) for you. | The playbook can install and configure [etkecc/synapse-admin](https://github.com/etkecc/synapse-admin) (a [feature-rich](https://github.com/etkecc/synapse-admin#fork-differences) fork of [Awesome-Technologies/synapse-admin](https://github.com/Awesome-Technologies/synapse-admin), community room: [#synapse-admin:etke.cc](https://matrix.to/#/#synapse-admin:etke.cc)) for you. | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Setting up Synapse Auto Invite Accept (optional) | # Setting up Synapse Auto Invite Accept (optional) | ||||
| The playbook can install and configure [synapse-auto-invite-accept](https://github.com/matrix-org/synapse-auto-accept-invite) for you. | The playbook can install and configure [synapse-auto-invite-accept](https://github.com/matrix-org/synapse-auto-accept-invite) for you. | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Setting up synapse-auto-compressor (optional) | # Setting up synapse-auto-compressor (optional) | ||||
| The playbook can install and configure [synapse_auto_compressor](https://github.com/matrix-org/rust-synapse-compress-state/#automated-tool-synapse_auto_compressor) for you. | The playbook can install and configure [synapse_auto_compressor](https://github.com/matrix-org/rust-synapse-compress-state/#automated-tool-synapse_auto_compressor) for you. | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Storing Synapse media files on Amazon S3 with synapse-s3-storage-provider (optional) | # Storing Synapse media files on Amazon S3 with synapse-s3-storage-provider (optional) | ||||
| If you'd like to store Synapse's content repository (`media_store`) files on Amazon S3 (or other S3-compatible service), you can use the [synapse-s3-storage-provider](https://github.com/matrix-org/synapse-s3-storage-provider) media provider module for Synapse. | If you'd like to store Synapse's content repository (`media_store`) files on Amazon S3 (or other S3-compatible service), you can use the [synapse-s3-storage-provider](https://github.com/matrix-org/synapse-s3-storage-provider) media provider module for Synapse. | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Setting up Synapse Simple Antispam (optional, advanced) | # Setting up Synapse Simple Antispam (optional, advanced) | ||||
| The playbook can install and configure [synapse-simple-antispam](https://github.com/t2bot/synapse-simple-antispam) for you. | The playbook can install and configure [synapse-simple-antispam](https://github.com/t2bot/synapse-simple-antispam) for you. | ||||
| @@ -1,3 +1,9 @@ | |||||
| <!-- | |||||
| SPDX-FileCopyrightText: 2024 MDAD Team and contributors | |||||
| SPDX-License-Identifier: AGPL-3.0-or-later | |||||
| --> | |||||
| # Enabling synapse-usage-exporter for Synapse usage statistics (optional) | # Enabling synapse-usage-exporter for Synapse usage statistics (optional) | ||||
| [synapse-usage-exporter](https://github.com/loelkes/synapse-usage-exporter) allows you to export the usage statistics of a Synapse homeserver to this container service and for the collected metrics to later be scraped by Prometheus. | [synapse-usage-exporter](https://github.com/loelkes/synapse-usage-exporter) allows you to export the usage statistics of a Synapse homeserver to this container service and for the collected metrics to later be scraped by Prometheus. | ||||