Compare commits

..

8 Commits

Author SHA1 Message Date
Slavi Pantaleev
d1c7f7eef1
Merge pull request #3685 from luixxiul/fix
Fix more capitalizations on documentation
2024-10-27 22:25:19 +02:00
Suguru Hirahara
2e343b44ea
Fix capitalization: Container Images → Container images 2024-10-28 04:00:59 +09:00
Suguru Hirahara
2d36bf17d5
Fix capitalization: heisenbridge → Heisenbridge
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-28 04:00:51 +09:00
Suguru Hirahara
e77b14a699
Fix capitalization: cinny → Cinny
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-28 04:00:45 +09:00
Suguru Hirahara
b71c4a1a3e
Consistent capitalization: honoroit → Honoroit
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-28 04:00:38 +09:00
Suguru Hirahara
601406ddda
Fix capitalization: buscarron → Buscarron
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-28 04:00:30 +09:00
Slavi Pantaleev
a74bd65d56
Merge pull request #3682 from luixxiul/fix
Synchronize document titles and links based on configuring-playbook.md
2024-10-27 20:39:56 +02:00
Suguru Hirahara
3d47e0d69c
Synchronize document titles and links based on configuring-playbook.md
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-10-26 21:28:31 +09:00
69 changed files with 106 additions and 106 deletions

View File

@ -876,7 +876,7 @@ Thanks to [Benjamin Kampmann](https://github.com/gnunicorn) for [getting it star
The upcoming Element X clients ([Element X iOS](https://github.com/vector-im/element-x-ios) and [Element X Android](https://github.com/vector-im/element-x-android)) require the `sliding-sync` proxy to do their job. **These clients are still in beta** (especially Element X Android, which requires manual compilation to get it working with a non-`matrix.org` homeseserver). Playbook users can now easily give these clients a try and help test them thanks to us having `sliding-sync` support.
To get started, see our [Setting up Sliding Sync proxy](docs/configuring-playbook-sliding-sync-proxy.md) documentation page.
To get started, see our [Setting up the Sliding Sync proxy](docs/configuring-playbook-sliding-sync-proxy.md) documentation page.
# 2023-03-02
@ -1464,7 +1464,7 @@ With the new Synapse-customization feature in the playbook, we use the original
Thanks to [@TheOneWithTheBraid](https://github.com/TheOneWithTheBraid), we now support installing [matrix-ldap-registration-proxy](https://gitlab.com/activism.international/matrix_ldap_registration_proxy) - a proxy which handles Matrix registration requests and forwards them to LDAP.
See our [Setting up the ldap-registration-proxy](docs/configuring-playbook-matrix-ldap-registration-proxy.md) documentation to get started.
See our [Setting up matrix-ldap-registration-proxy](docs/configuring-playbook-matrix-ldap-registration-proxy.md) documentation to get started.
# 2022-09-15
@ -1564,7 +1564,7 @@ Below we'll discuss **potential backward incompatibilities**.
Thanks to [Julian-Samuel Gebühr (@moan0s)](https://github.com/moan0s), the playbook can now set up [Cactus Comments](https://cactus.chat) - federated comment system for the web based on Matrix.
See our [Setting up a Cactus Comments server](docs/configuring-playbook-cactus-comments.md) documentation to get started.
See our [Setting up Cactus Comments](docs/configuring-playbook-cactus-comments.md) documentation to get started.
# 2022-08-23
@ -1708,7 +1708,7 @@ See our [Setting up the ntfy push notifications server](docs/configuring-playboo
Thanks to [CyberShadow](https://github.com/CyberShadow), the playbook can now install the [go-skype-bridge](https://github.com/kelaresg/go-skype-bridge) bridge for bridging Matrix to [Skype](https://www.skype.com/).
See our [Setting up Go Skype Bridge](docs/configuring-playbook-bridge-go-skype-bridge.md) documentation to get started.
See our [Setting up Go Skype Bridge bridging](docs/configuring-playbook-bridge-go-skype-bridge.md) documentation to get started.
The playbook has supported [mx-puppet-skype](https://github.com/Sorunome/mx-puppet-skype) bridging (see [Setting up MX Puppet Skype bridging](docs/configuring-playbook-bridge-mx-puppet-skype.md)) since [2020-04-09](#2020-04-09), but `mx-puppet-skype` is reportedly broken.
@ -1757,7 +1757,7 @@ You could then restart services: `ansible-playbook -i inventory/hosts setup.yml
# 2022-04-25
## buscarron bot support
## Buscarron bot support
Thanks to [Aine](https://gitlab.com/etke.cc) of [etke.cc](https://etke.cc/), the playbook can now set up [the Buscarron bot](https://github.com/etkecc/buscarron). It's a bot you can use to send any form (HTTP POST, HTML) to a (encrypted) Matrix room
@ -2038,7 +2038,7 @@ The playbook can now install the [Sygnal](https://github.com/matrix-org/sygnal)
This is only useful to people who develop/build their own Matrix client applications.
Additional details are available in our [Setting up Sygnal](docs/configuring-playbook-sygnal.md) docs.
Additional details are available in our [Setting up the Sygnal push gateway](docs/configuring-playbook-sygnal.md) docs.
# 2021-03-16
@ -2717,7 +2717,7 @@ It forces a [Postgres database upgrade](docs/maintenance-postgres.md#upgrading-p
Thanks to a contribution from [Björn Marten](https://github.com/tripleawwy) from [netresearch](https://www.netresearch.de/), the playbook can now install and configure [matrix-appservice-webhooks](https://github.com/turt2live/matrix-appservice-webhooks) for you. This bridge provides support for Slack-compatible webhooks.
Learn more in [Setting up Appservice Webhooks](docs/configuring-playbook-bridge-appservice-webhooks.md).
Learn more in [Setting up Appservice Webhooks bridging](docs/configuring-playbook-bridge-appservice-webhooks.md).
# 2020-01-12
@ -3292,7 +3292,7 @@ When using:
## IRC bridging support
[Devon Maloney (@Plailect)](https://github.com/Plailect) has done some great work bringing IRC bridging support via [matrix-appservice-irc](https://github.com/TeDomum/matrix-appservice-irc).
To learn more, see the [Setting up Appservice IRC](docs/configuring-playbook-bridge-appservice-irc.md) documentation page.
To learn more, see the [Setting up Appservice IRC bridging](docs/configuring-playbook-bridge-appservice-irc.md) documentation page.
# 2019-01-29
@ -3757,7 +3757,7 @@ The Client APIs run only on the http port (8008) now.
## mxisd Identity Server support
The playbook now sets up an [mxisd](https://github.com/kamax-io/mxisd) Identity Server for you by default.
Additional details are available in [Adjusting mxisd Identity Server configuration](docs/configuring-playbook-mxisd.md).
Additional details are available in [Setting up ma1sd Identity Server](docs/configuring-playbook-mxisd.md).
# 2018-08-14

View File

@ -137,7 +137,7 @@ Bots provide various additional functionality to your installation.
| [matrix-reminder-bot](https://github.com/anoadragon453/matrix-reminder-bot) | x | Bot for scheduling one-off & recurring reminders and alarms | [Link](docs/configuring-playbook-bot-matrix-reminder-bot.md) |
| [matrix-registration-bot](https://github.com/moan0s/matrix-registration-bot) | x | Bot for invitations by creating and managing registration tokens | [Link](docs/configuring-playbook-bot-matrix-registration-bot.md) |
| [maubot](https://github.com/maubot/maubot) | x | A plugin-based Matrix bot system | [Link](docs/configuring-playbook-bot-maubot.md) |
| [honoroit](https://github.com/etkecc/honoroit) | x | A helpdesk bot | [Link](docs/configuring-playbook-bot-honoroit.md) |
| [Honoroit](https://github.com/etkecc/honoroit) | x | A helpdesk bot | [Link](docs/configuring-playbook-bot-honoroit.md) |
| [Postmoogle](https://github.com/etkecc/postmoogle) | x | Email to Matrix bot | [Link](docs/configuring-playbook-bot-postmoogle.md) |
| [Go-NEB](https://github.com/matrix-org/go-neb) | x | A multi functional bot written in Go | [Link](docs/configuring-playbook-bot-go-neb.md) |
| [Mjolnir](https://github.com/matrix-org/mjolnir) | x | A moderation tool for Matrix | [Link](docs/configuring-playbook-bot-mjolnir.md) |

View File

@ -79,7 +79,7 @@ The `schildichat.example.com` subdomain may be necessary, because this playbook
The `wsproxy.example.com` subdomain may be necessary, because this playbook could install the [wsproxy](https://github.com/mautrix/wsproxy) web client. The installation of wsproxy is disabled by default, it is not a core required component. To learn how to install it, see our [configuring wsproxy guide](configuring-playbook-bridge-mautrix-wsproxy.md). If you do not wish to set up wsproxy, feel free to skip the `wsproxy.example.com` DNS record.
The `buscarron.example.com` subdomain may be necessary, because this playbook could install the [buscarron](https://github.com/etkecc/buscarron) bot. The installation of buscarron is disabled by default, it is not a core required component. To learn how to install it, see our [configuring buscarron guide](configuring-playbook-bot-buscarron.md). If you do not wish to set up buscarron, feel free to skip the `buscarron.example.com` DNS record.
The `buscarron.example.com` subdomain may be necessary, because this playbook could install the [Buscarron](https://github.com/etkecc/buscarron) bot. The installation of Buscarron is disabled by default, it is not a core required component. To learn how to install it, see our [configuring Buscarron guide](configuring-playbook-bot-buscarron.md). If you do not wish to set up Buscarron, feel free to skip the `buscarron.example.com` DNS record.
The `rageshake.example.com` subdomain may be necessary, because this playbook could install the [rageshake](https://github.com/matrix-org/rageshake) bug report server. The installation of rageshake is disabled by default, it is not a core required component. To learn how to install it, see our [configuring rageshake guide](configuring-playbook-rageshake.md). If you do not wish to set up rageshake, feel free to skip the `rageshake.example.com` DNS record.

View File

@ -1,4 +1,4 @@
# Setting up 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.

View File

@ -1,4 +1,4 @@
# Serving the base domain
# Serving the base domain (optional)
This playbook sets up services on your Matrix server (`matrix.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](howto-server-delegation.md). This is normally done by [configuring well-known](configuring-well-known.md) files on the base domain.

View File

@ -1,6 +1,6 @@
# 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.
Buscarron is bot that receives HTTP POST submissions of web forms and forwards them to a Matrix room.

View File

@ -1,4 +1,4 @@
# Setting up ChatGPT (optional)
# Setting up matrix-bot-chatgpt (optional)
The playbook can install and configure [matrix-chatgpt-bot](https://github.com/matrixgpt/matrix-chatgpt-bot) for you.

View File

@ -1,4 +1,4 @@
# Setting up Postmoogle (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.

View File

@ -1,4 +1,4 @@
# Setting up Appservice Discord (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.
- For using as a Bot we are recommend the Appservice Discord bridge (the one being discussed here), because it supports plumbing.

View File

@ -1,4 +1,4 @@
# Setting up Appservice IRC (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.

View File

@ -1,4 +1,4 @@
# Setting up Appservice Kakaotalk (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.

View File

@ -1,4 +1,4 @@
# Setting up Appservice Slack (optional)
# Setting up Appservice 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 [mautrix-slack](configuring-playbook-bridge-mautrix-slack.md) bridges supported by the playbook.

View File

@ -1,4 +1,4 @@
# Setting up Appservice Webhooks (optional)
# Setting up Appservice Webhooks bridging (optional)
The playbook can install and configure [matrix-appservice-webhooks](https://github.com/turt2live/matrix-appservice-webhooks) for you.

View File

@ -1,4 +1,4 @@
# Setting up Beeper Linkedin (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

View File

@ -1,4 +1,4 @@
# Setting up Go Skype Bridge (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.

View File

@ -1,4 +1,4 @@
# Setting up Heisenbridge (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.

View File

@ -1,4 +1,4 @@
# Setting up Hookshot (optional)
# Setting up matrix-hookshot (optional)
The playbook can install and configure [matrix-hookshot](https://github.com/matrix-org/matrix-hookshot) for you.

View File

@ -1,4 +1,4 @@
# Setting up matrix-sms-bridge (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.

View File

@ -1,4 +1,4 @@
# Setting up Mautrix Discord (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.
- For using as a Bot we recommend the [Appservice Discord](configuring-playbook-bridge-appservice-discord.md), because it supports plumbing.

View File

@ -1,4 +1,4 @@
# Setting up Mautrix Facebook (optional)
# Setting up Mautrix Facebook bridging (optional)
**Note**: bridging to Facebook [Messenger](https://messenger.com) via this bridge is being [superseded by a new bridge - mautrix-meta](https://github.com/mautrix/facebook/issues/332). For now, the mautrix-facebook bridge continues to work, but the new [mautrix-meta-messenger bridge](./configuring-playbook-bridge-mautrix-meta-messenger.md) is better and more supported. Consider using that bridge instead of this one.

View File

@ -1,4 +1,4 @@
# Setting up Mautrix gmessages (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/).

View File

@ -1,4 +1,4 @@
# Setting up Mautrix Google Chat (optional)
# Setting up Mautrix Google Chat bridging (optional)
The playbook can install and configure [mautrix-googlechat](https://github.com/mautrix/googlechat) for you.

View File

@ -1,6 +1,6 @@
# The [Mautrix Hangouts Bridge](https://mau.dev/mautrix/hangouts) is no longer maintained. It has changed to a [Google Chat Bridge](https://github.com/mautrix/googlechat). Setup instructions for the Google Chat Bridge can be [found here](configuring-playbook-bridge-mautrix-googlechat.md).
# Setting up Mautrix Hangouts (optional)
# Setting up Mautrix Hangouts bridging (optional)
The playbook can install and configure [mautrix-hangouts](https://github.com/mautrix/hangouts) for you.

View File

@ -1,4 +1,4 @@
# Setting up Mautrix Instagram (optional)
# Setting up Mautrix Instagram bridging (optional)
**Note**: bridging to Facebook [Instagram](https://instagram.com) via this bridge is being [superseded by a new bridge - mautrix-meta](https://github.com/mautrix/facebook/issues/332). For now, the mautrix-instagram bridge continues to work, but the new [mautrix-meta-instagram bridge](./configuring-playbook-bridge-mautrix-meta-instagram.md) is better and more supported. Consider using that bridge instead of this one.

View File

@ -1,4 +1,4 @@
# Setting up Mautrix Signal (optional)
# Setting up Mautrix Signal bridging (optional)
The playbook can install and configure [mautrix-signal](https://github.com/mautrix/signal) for you.

View File

@ -1,4 +1,4 @@
# Setting up Mautrix Slack (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.
- For using as a Bot we recommend the [Appservice Slack](configuring-playbook-bridge-appservice-slack.md), because it supports plumbing.

View File

@ -1,4 +1,4 @@
# Setting up Mautrix Telegram (optional)
# Setting up Mautrix Telegram bridging (optional)
The playbook can install and configure [mautrix-telegram](https://github.com/mautrix/telegram) for you.

View File

@ -1,4 +1,4 @@
# Setting up Mautrix Twitter (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.

View File

@ -1,4 +1,4 @@
# Setting up Mautrix Whatsapp (optional)
# Setting up Mautrix Whatsapp bridging (optional)
The playbook can install and configure [mautrix-whatsapp](https://github.com/mautrix/whatsapp) for you.

View File

@ -1,4 +1,4 @@
# Setting up Mautrix wsproxy (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.

View File

@ -1,4 +1,4 @@
# Setting up MX Puppet Discord (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.
- For using as a Bot we recommend the [Appservice Discord](configuring-playbook-bridge-appservice-discord.md), because it supports plumbing.

View File

@ -1,4 +1,4 @@
# Setting up MX Puppet GroupMe (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.

View File

@ -1,4 +1,4 @@
# Setting up mx-puppet-instagram (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.

View File

@ -1,4 +1,4 @@
# Setting up MX Puppet Skype (optional)
# Setting up MX Puppet Skype bridging (optional)
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 unmaintaned for a long time.

View File

@ -1,4 +1,4 @@
# Setting up MX Puppet Slack (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.

View File

@ -1,4 +1,4 @@
# Setting up MX Puppet Steam (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.

View File

@ -1,4 +1,4 @@
# Setting up MX Puppet Twitter (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.

View File

@ -1,4 +1,4 @@
# Setting up the WeChat Bridge (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).

View File

@ -1,6 +1,6 @@
# Configuring 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.
Cinny is a web client focusing primarily on simple, elegant and secure interface. It can be installed alongside or instead of Element.

View File

@ -1,4 +1,4 @@
# Configuring Hydrogen (optional)
# Setting up Hydrogen (optional)
This playbook can install the [Hydrogen](https://github.com/element-hq/hydrogen-web) Matrix web client for you.

View File

@ -1,4 +1,4 @@
# Configuring SchildiChat (optional)
# Setting up SchildiChat (optional)
This playbook can install the [SchildiChat](https://github.com/SchildiChat/schildichat-desktop) Matrix web client for you.

View File

@ -1,4 +1,4 @@
# Setting up Dimension (optional)
# Setting up Dimension integration manager (optional)
**[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.

View File

@ -1,4 +1,4 @@
# Dynamic DNS
# Setting up Dynamic DNS (optional)
## Setup

View File

@ -1,4 +1,4 @@
# Jitsi
# 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](configuring-playbook-client-element.md).

View File

@ -1,4 +1,4 @@
# Adjusting ma1sd Identity Server configuration (optional)
# Setting up ma1sd Identity Server (optional)
The playbook can configure the [ma1sd](https://github.com/ma1uta/ma1sd) Identity Server for you.

View File

@ -1,4 +1,4 @@
# Matrix Authentication Service (MAS)
# 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/).

View File

@ -1,4 +1,4 @@
# Setting up 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.

View File

@ -1,4 +1,4 @@
# Setting up ntfy (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.

View File

@ -1,4 +1,4 @@
# Setting up pantalaimon (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.

View File

@ -1,4 +1,4 @@
# Enabling metrics and graphs 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.

View File

@ -1,4 +1,4 @@
# Setting up rageshake (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.

View File

@ -1,4 +1,4 @@
# Setting up Sliding Sync proxy (optional)
# Setting up the Sliding Sync proxy (optional)
The playbook can install and configure [sliding-sync](https://github.com/matrix-org/sliding-sync) proxy for you.

View File

@ -1,4 +1,4 @@
# Setting up Sygnal (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.

View File

@ -1,4 +1,4 @@
# Setting up synapse_auto_compressor
# 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.

View File

@ -1,4 +1,4 @@
# Setting up synapse-usage-exporter (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.

View File

@ -1,4 +1,4 @@
# TURN server
# Adjusting TURN server configuration (optional, advanced)
The playbook installs a [Coturn](https://github.com/coturn/coturn) TURN server by default, so that clients can make audio/video calls even from [NAT](https://en.wikipedia.org/wiki/Network_address_translation)-ed networks.

View File

@ -64,11 +64,11 @@ When you're done with all the configuration you'd like to do, continue with [Ins
- [Adjusting SSL certificate retrieval](configuring-playbook-ssl-certificates.md) (optional, advanced)
- [Serving your base domain using this playbook's nginx server](configuring-playbook-base-domain-serving.md) (optional)
- [Serving the base domain](configuring-playbook-base-domain-serving.md) (optional)
- [Configuring the Traefik reverse-proxy](configuring-playbook-traefik.md) (optional, advanced)
- [Using your own webserver, instead of this playbook's default reverse-proxy](configuring-playbook-own-webserver.md) (optional, advanced)
- [Using your own webserver, instead of this playbook's Traefik reverse-proxy](configuring-playbook-own-webserver.md) (optional, advanced)
- [Adjusting TURN server configuration](configuring-playbook-turn.md) (optional, advanced)
@ -94,7 +94,7 @@ When you're done with all the configuration you'd like to do, continue with [Ins
- [Setting up Appservice Double Puppet](configuring-playbook-appservice-double-puppet.md) (optional)
- [Setting up an ma1sd Identity Server](configuring-playbook-ma1sd.md) (optional)
- [Setting up ma1sd Identity Server](configuring-playbook-ma1sd.md) (optional)
- [Setting up Synapse Admin](configuring-playbook-synapse-admin.md) (optional)
@ -104,9 +104,9 @@ When you're done with all the configuration you'd like to do, continue with [Ins
- [Setting up the Shared Secret Auth password provider module](configuring-playbook-shared-secret-auth.md) (optional, advanced)
- [Setting up the LDAP password provider module](configuring-playbook-ldap-auth.md) (optional, advanced)
- [Setting up the LDAP authentication password provider module](configuring-playbook-ldap-auth.md) (optional, advanced)
- [Setting up the ldap-registration-proxy](configuring-playbook-matrix-ldap-registration-proxy.md) (optional, advanced)
- [Setting up matrix-ldap-registration-proxy](configuring-playbook-matrix-ldap-registration-proxy.md) (optional, advanced)
- [Setting up Synapse Simple Antispam](configuring-playbook-synapse-simple-antispam.md) (optional, advanced)
@ -200,7 +200,7 @@ When you're done with all the configuration you'd like to do, continue with [Ins
- [Setting up maubot](configuring-playbook-bot-maubot.md) - a plugin-based Matrix bot system (optional)
- [Setting up honoroit](configuring-playbook-bot-honoroit.md) - a helpdesk bot (optional)
- [Setting up Honoroit](configuring-playbook-bot-honoroit.md) - a helpdesk bot (optional)
- [Setting up Go-NEB](configuring-playbook-bot-go-neb.md) - an extensible multifunctional bot (optional)
@ -208,7 +208,7 @@ When you're done with all the configuration you'd like to do, continue with [Ins
- [Setting up Draupnir](configuring-playbook-bot-draupnir.md) - a moderation tool/bot, forked from Mjolnir and maintained by its former leader developer (optional)
- [Setting up Draupnir for all](configuring-playbook-appservice-draupnir-for-all.md) - like the [Draupnir bot](configuring-playbook-bot-draupnir.md) mentioned above, but running in appservice mode and supporting multiple instances (optional)
- [Setting up Draupnir for all/D4A](configuring-playbook-appservice-draupnir-for-all.md) - like the [Draupnir bot](configuring-playbook-bot-draupnir.md) mentioned above, but running in appservice mode and supporting multiple instances (optional)
- [Setting up Buscarron](configuring-playbook-bot-buscarron.md) - a bot you can use to send any form (HTTP POST, HTML) to a (encrypted) Matrix room (optional)
@ -230,7 +230,7 @@ When you're done with all the configuration you'd like to do, continue with [Ins
- [Setting up the ntfy push notifications server](configuring-playbook-ntfy.md) (optional)
- [Setting up a Cactus Comments server](configuring-playbook-cactus-comments.md) - a federated comment system built on Matrix (optional)
- [Setting up Cactus Comments](configuring-playbook-cactus-comments.md) - a federated comment system built on Matrix (optional)
- [Setting up the rageshake bug report server](configuring-playbook-rageshake.md) (optional)

View File

@ -1,4 +1,4 @@
# Container Images used by the playbook
# Container images used by the playbook
This page summarizes the container ([Docker](https://www.docker.com/)) images used by the playbook when setting up your server.
@ -100,7 +100,7 @@ These services are not part of our default installation, but can be enabled by [
- [dock.mau.dev/maubot/maubot](https://mau.dev/maubot/maubot/container_registry) - the [maubot](https://github.com/maubot/maubot) bot (a plugin-based Matrix bot system) (optional)
- [etke.cc/honoroit](https://github.com/etkecc/honoroit/container_registry) - the [honoroit](https://github.com/etkecc/honoroit) helpdesk bot (optional)
- [etke.cc/honoroit](https://github.com/etkecc/honoroit/container_registry) - the [Honoroit](https://github.com/etkecc/honoroit) helpdesk bot (optional)
- [etke.cc/postmoogle](https://github.com/etkecc/postmoogle/container_registry) - the [Postmoogle](https://github.com/etkecc/postmoogle) email bridge bot (optional)

View File

@ -80,7 +80,7 @@ matrix_server_fqn_cinny: "cinny.{{ matrix_domain }}"
# This is where you access the SchildiChat web client from (if enabled via matrix_client_schildichat_enabled; disabled by default).
matrix_server_fqn_schildichat: "schildichat.{{ matrix_domain }}"
# This is where you access the buscarron bot from (if enabled via matrix_bot_buscarron_enabled; disabled by default).
# This is where you access the Buscarron bot from (if enabled via matrix_bot_buscarron_enabled; disabled by default).
matrix_server_fqn_buscarron: "buscarron.{{ matrix_domain }}"
# This is where you access the Dimension.

View File

@ -1,6 +1,6 @@
---
# buscarron is a Web forms (HTTP POST) to Matrix service.
# Buscarron is a Web forms (HTTP POST) to Matrix service.
# Project source code URL: https://github.com/etkecc/buscarron
matrix_bot_buscarron_enabled: true
@ -186,7 +186,7 @@ matrix_bot_buscarron_smtp_from: ''
# enforce SMTP validation
matrix_bot_buscarron_smtp_validation: false
# Additional environment variables to pass to the buscarron container
# Additional environment variables to pass to the Buscarron container
#
# Example:
# matrix_bot_buscarron_environment_variables_extension: |

View File

@ -26,7 +26,7 @@
- ansible.builtin.set_fact:
matrix_bot_buscarron_requires_restart: true
- name: Ensure buscarron paths exist
- name: Ensure Buscarron paths exist
ansible.builtin.file:
path: "{{ item.path }}"
state: directory
@ -40,7 +40,7 @@
- {path: "{{ matrix_bot_buscarron_docker_src_files_path }}", when: true}
when: "item.when | bool"
- name: Ensure buscarron support files installed
- name: Ensure Buscarron support files installed
ansible.builtin.template:
src: "{{ role_path }}/templates/{{ item }}.j2"
dest: "{{ matrix_bot_buscarron_config_path }}/{{ item }}"
@ -51,7 +51,7 @@
- env
- labels
- name: Ensure buscarron image is pulled
- name: Ensure Buscarron image is pulled
community.docker.docker_image:
name: "{{ matrix_bot_buscarron_docker_image }}"
source: "{{ 'pull' if ansible_version.major > 2 or ansible_version.minor > 7 else omit }}"
@ -63,7 +63,7 @@
delay: "{{ devture_playbook_help_container_retries_delay }}"
until: result is not failed
- name: Ensure buscarron repository is present on self-build
- name: Ensure Buscarron repository is present on self-build
ansible.builtin.git:
repo: "{{ matrix_bot_buscarron_docker_repo }}"
version: "{{ matrix_bot_buscarron_docker_repo_version }}"
@ -74,7 +74,7 @@
register: matrix_bot_buscarron_git_pull_results
when: "matrix_bot_buscarron_container_image_self_build | bool"
- name: Ensure buscarron image is built
- name: Ensure Buscarron image is built
community.docker.docker_image:
name: "{{ matrix_bot_buscarron_docker_image }}"
source: build
@ -92,7 +92,7 @@
dest: "{{ devture_systemd_docker_base_systemd_path }}/matrix-bot-buscarron.service"
mode: 0644
- name: Ensure buscarron container network is created
- name: Ensure Buscarron container network is created
community.general.docker_network:
enable_ipv6: "{{ devture_systemd_docker_base_ipv6_enabled }}"
name: "{{ matrix_bot_buscarron_container_network }}"

View File

@ -19,7 +19,7 @@
path: "{{ devture_systemd_docker_base_systemd_path }}/matrix-bot-buscarron.service"
state: absent
- name: Ensure Matrix buscarron paths don't exist
- name: Ensure Matrix Buscarron paths don't exist
ansible.builtin.file:
path: "{{ matrix_bot_buscarron_base_path }}"
state: absent

View File

@ -1,17 +1,17 @@
---
# honoroit is a helpdesk bot
# Honoroit is a helpdesk bot
# Project source code URL: https://github.com/etkecc/honoroit
matrix_bot_honoroit_enabled: true
# The hostname at which honoroit is served.
# The hostname at which Honoroit is served.
matrix_bot_honoroit_hostname: ''
# The path at which honoroit is exposed.
# The path at which Honoroit is exposed.
# This value must either be `/` or not end with a slash (e.g. `/honoroit`).
matrix_bot_honoroit_path_prefix: /
# The path at which honoroit will expose metrics
# The path at which Honoroit will expose metrics
# This value must either be `/` or not end with a slash (e.g. `/metrics`).
matrix_bot_honoroit_metrics_path: /metrics
@ -161,7 +161,7 @@ matrix_bot_honoroit_redmine_new_status_id: '' # new status ID (e.g. 1)
matrix_bot_honoroit_redmine_in_progress_status_id: '' # in progress status ID (e.g. 2)
matrix_bot_honoroit_redmine_done_status_id: '' # done status ID (e.g. 3)
# A list of whitelisted users allowed to use/invite honoroit
# A list of whitelisted users allowed to use/invite a Honoroit bot
# If not defined, everyone is allowed.
# Example set of rules:
# matrix_bot_honoroit_allowedusers:

View File

@ -26,7 +26,7 @@
- ansible.builtin.set_fact:
matrix_bot_honoroit_requires_restart: true
- name: Ensure honoroit paths exist
- name: Ensure Honoroit paths exist
ansible.builtin.file:
path: "{{ item.path }}"
state: directory
@ -40,7 +40,7 @@
- {path: "{{ matrix_bot_honoroit_docker_src_files_path }}", when: true}
when: "item.when | bool"
- name: Ensure honoroit support files installed
- name: Ensure Honoroit support files installed
ansible.builtin.template:
src: "{{ role_path }}/templates/{{ item }}.j2"
dest: "{{ matrix_bot_honoroit_config_path }}/{{ item }}"
@ -51,7 +51,7 @@
- env
- labels
- name: Ensure honoroit image is pulled
- name: Ensure Honoroit image is pulled
community.docker.docker_image:
name: "{{ matrix_bot_honoroit_docker_image }}"
source: "{{ 'pull' if ansible_version.major > 2 or ansible_version.minor > 7 else omit }}"
@ -63,7 +63,7 @@
delay: "{{ devture_playbook_help_container_retries_delay }}"
until: result is not failed
- name: Ensure honoroit repository is present on self-build
- name: Ensure Honoroit repository is present on self-build
ansible.builtin.git:
repo: "{{ matrix_bot_honoroit_docker_repo }}"
version: "{{ matrix_bot_honoroit_docker_repo_version }}"
@ -74,7 +74,7 @@
register: matrix_bot_honoroit_git_pull_results
when: "matrix_bot_honoroit_container_image_self_build | bool"
- name: Ensure honoroit image is built
- name: Ensure Honoroit image is built
community.docker.docker_image:
name: "{{ matrix_bot_honoroit_docker_image }}"
source: build
@ -86,7 +86,7 @@
pull: true
when: "matrix_bot_honoroit_container_image_self_build | bool"
- name: Ensure honoroit container network is created
- name: Ensure Honoroit container network is created
community.general.docker_network:
enable_ipv6: "{{ devture_systemd_docker_base_ipv6_enabled }}"
name: "{{ matrix_bot_honoroit_container_network }}"

View File

@ -19,7 +19,7 @@
path: "{{ devture_systemd_docker_base_systemd_path }}/matrix-bot-honoroit.service"
state: absent
- name: Ensure Matrix honoroit paths don't exist
- name: Ensure Matrix Honoroit paths don't exist
ansible.builtin.file:
path: "{{ matrix_bot_honoroit_base_path }}"
state: absent

View File

@ -1,6 +1,6 @@
---
- name: Fail if required honoroit settings not defined
- name: Fail if required Honoroit settings not defined
ansible.builtin.fail:
msg: >-
You need to define a required configuration setting (`{{ item.name }}`).

View File

@ -1,5 +1,5 @@
---
# heisenbridge is a bouncer-style Matrix IRC bridge
# Heisenbridge is a bouncer-style Matrix IRC bridge
# Project source code URL: https://github.com/hifi/heisenbridge
matrix_heisenbridge_enabled: true
@ -93,7 +93,7 @@ matrix_heisenbridge_registration_yaml_heisenbridge:
displayname: "{{ matrix_heisenbridge_config_displayname }}"
# Default registration file consumed by both the homeserver and Heisenbridge.
# Besides registration information, it contains configuration (see the heisenbridge key).
# Besides registration information, it contains configuration (see the Heisenbridge key).
matrix_heisenbridge_registration_yaml:
id: heisenbridge
url: http://matrix-heisenbridge:9898

View File

@ -1,6 +1,6 @@
---
- name: Ensure heisenbridge image is pulled
- name: Ensure Heisenbridge image is pulled
community.docker.docker_image:
name: "{{ matrix_heisenbridge_docker_image }}"
source: "{{ 'pull' if ansible_version.major > 2 or ansible_version.minor > 7 else omit }}"
@ -11,7 +11,7 @@
delay: "{{ devture_playbook_help_container_retries_delay }}"
until: result is not failed
- name: Ensure heisenbridge paths exist
- name: Ensure Heisenbridge paths exist
ansible.builtin.file:
path: "{{ item }}"
state: directory
@ -21,7 +21,7 @@
with_items:
- "{{ matrix_heisenbridge_base_path }}"
- name: Ensure heisenbridge registration.yaml installed if provided
- name: Ensure Heisenbridge registration.yaml installed if provided
ansible.builtin.copy:
content: "{{ matrix_heisenbridge_registration | to_nice_yaml(indent=2, width=999999) }}"
dest: "{{ matrix_heisenbridge_base_path }}/registration.yaml"
@ -29,7 +29,7 @@
owner: "{{ matrix_user_username }}"
group: "{{ matrix_user_groupname }}"
- name: Ensure heisenbridge support files installed
- name: Ensure Heisenbridge support files installed
ansible.builtin.template:
src: "{{ role_path }}/templates/{{ item }}.j2"
dest: "{{ matrix_heisenbridge_base_path }}/{{ item }}"
@ -39,7 +39,7 @@
with_items:
- labels
- name: Ensure heisenbridge container network is created
- name: Ensure Heisenbridge container network is created
community.general.docker_network:
enable_ipv6: "{{ devture_systemd_docker_base_ipv6_enabled }}"
name: "{{ matrix_heisenbridge_container_network }}"

View File

@ -1,6 +1,6 @@
---
- name: Fail if required heisenbridge settings not defined
- name: Fail if required Heisenbridge settings not defined
ansible.builtin.fail:
msg: >-
You need to define a required configuration setting (`{{ item.name }}`).