mirror/matrix-docker-ansible-deploy
1
0
Fork 0
mirror of https://github.com/spantaleev/matrix-docker-ansible-deploy.git synced 2024-11-06 02:37:31 +01:00
Code Issues Packages Projects Releases Wiki Activity

Compare commits

base: mirror:e93b37eea842d70d2ca40c465b86b505fe4bd81e
Branches Tags
mirror:master
mirror:renovate/matrixdotorg-mjolnir-1.x
mirror:renovate/zeratax-matrix-registration-0.x
mirror:renovate/ghcr.io-matrixgpt-matrix-chatgpt-bot-3.x
mirror:synapse-cache-tuning
mirror:HarHarLinks/hookshot-encryption
...
compare: mirror:ac2e36ce929c0dcfc3ab2f51eba031bb254fbdc6
Branches Tags
mirror:master
mirror:renovate/matrixdotorg-mjolnir-1.x
mirror:renovate/zeratax-matrix-registration-0.x
mirror:renovate/ghcr.io-matrixgpt-matrix-chatgpt-bot-3.x
mirror:synapse-cache-tuning
mirror:HarHarLinks/hookshot-encryption

19 Commits
e93b37eea8 ... ac2e36ce92

Author SHA1 Message Date
smargold476
ac2e36ce92
Merge 79a983f0c7 into 970ae997b6 2024-11-04 16:29:31 +09:00
Slavi Pantaleev
970ae997b6
Merge pull request #3736 from ikkemaniac/patch-1 
improve readability configuring-dns.md
 2024-11-04 08:31:27 +02:00
Slavi Pantaleev
08a19ac4ee
Merge pull request #3737 from luixxiul/fix 
Update README.md and docs/container-images.md
 2024-11-04 08:13:40 +02:00
Suguru Hirahara
7b9aaceb7e
Update README.md and docs/container-images.md: move "synapse-simple-antispam" to Authentication, following docs/configuring-playbook.md 
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
 2024-11-04 13:11:37 +09:00
Suguru Hirahara
c8ee67aa3b
Update README.md and docs/container-images.md: move up Exim as default service 
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
 2024-11-04 13:10:26 +09:00
ikkemaniac
7864a75607
improve readability configuring-dns.md 2024-11-03 21:08:10 +01:00
Slavi Pantaleev
8078a8ad2e
Merge pull request #3734 from luixxiul/fix 
Update docs/configuring-playbook.md: adopt the same structure and order for entries as ones on README.md
 2024-11-03 21:08:42 +02:00
Suguru Hirahara
68b8f1137f
Update docs/configuring-playbook.md and docs/container-images.md: add explanations to each section 
These sentences are copied from README.md

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
 2024-11-03 19:43:06 +09:00
Suguru Hirahara
16104b6e57
Update docs/configuring-playbook.md: move entries to "Other specialized services" section 
These entries are ones categorized under "Misc" section on README.md

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
 2024-11-03 19:41:59 +09:00
Suguru Hirahara
69273b30e4
Update docs/configuring-playbook.md: create "Administration" section 
Reorganize "Additional useful services" section and "Other specialized services" section

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
 2024-11-03 19:39:54 +09:00
Suguru Hirahara
d630668f46
Update docs/configuring-playbook.md: move "Additional useful services" section down under "Bots" section 
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
 2024-11-03 19:38:45 +09:00
Suguru Hirahara
2376821722
Update docs/configuring-playbook.md: create "File Storage" section under "Authentication and user-related" section 
This basically follows the order of the tables on README.md

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
 2024-11-03 19:37:59 +09:00
Suguru Hirahara
eaeb2f99b5
Update docs/configuring-playbook.md: move "Authentication and user-related" section up 
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
 2024-11-03 19:37:40 +09:00
Suguru Hirahara
15fd33fb45
Update docs/configuring-playbook.md: merge "Server connectivity" section to "Core service adjustments" section 
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
 2024-11-03 19:37:13 +09:00
Suguru Hirahara
c404995456
Update docs/configuring-playbook.md: create a list for server components based on the table on README.md 
Also: update README.md and docs/container-images.md

Move Sygnal and ntfy from "Server Components" to "Misc", following the existing categorization on docs/configuring-playbook.md where they are categorized as "Other specialzed services". This categorization makes more sense as they are not really services which make the components on the server work (per README.md)

Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
 2024-11-03 19:34:41 +09:00
Suguru Hirahara
7511b3d3ea
Update docs/configuring-playbook.md: create a section "Clients" 
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
 2024-11-03 19:32:59 +09:00
Suguru Hirahara
6e92a5da3f
Update docs/configuring-playbook.md: move "Core service adjustments" section up 
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
 2024-11-03 19:32:03 +09:00
smargold476
79a983f0c7
tg-bot docs update 
update infos reg. whitelist-filtering
 2022-10-22 21:01:05 +02:00
smargold476
41a80463eb
Update TG Group-Filtering-Docs 2022-10-22 20:58:29 +02:00
5 changed files with 96 additions and 63 deletions
Show Stats Expand all files Collapse all files

10
README.md
View File

@ -63,11 +63,9 @@ Services that run on the server to make the various parts of your installation w
| [Coturn](https://github.com/coturn/coturn) | ✓ | STUN/TURN server for WebRTC audio/video calls | [Link](docs/configuring-playbook-turn.md) |
| [Traefik](https://doc.traefik.io/traefik/) | ✓ | Web server, listening on ports 80, 443 and 8448 - standing in front of all the other services. Using your own webserver [is possible](docs/configuring-playbook-own-webserver.md) | [Link](docs/configuring-playbook-traefik.md) |
| [Let's Encrypt](https://letsencrypt.org/) | ✓ | Free SSL certificate, which secures the connection to all components | [Link](docs/configuring-playbook-ssl-certificates.md) |
| [ma1sd](https://github.com/ma1uta/ma1sd) | x | Matrix Identity Server | [Link](docs/configuring-playbook-ma1sd.md)
| [Exim](https://www.exim.org/) | ✓ | Mail server, through which all Matrix services send outgoing email (can be configured to relay through another SMTP server) | [Link](docs/configuring-playbook-email.md) |
| [ma1sd](https://github.com/ma1uta/ma1sd) | x | Matrix Identity Server | [Link](docs/configuring-playbook-ma1sd.md)
| [ddclient](https://github.com/linuxserver/docker-ddclient) | x | Dynamic DNS | [Link](docs/configuring-playbook-dynamic-dns.md) |
| [Sygnal](https://github.com/matrix-org/sygnal) | x | Push gateway | [Link](docs/configuring-playbook-sygnal.md) |
| [ntfy](https://ntfy.sh) | x | Push notifications server | [Link](docs/configuring-playbook-ntfy.md) |
### Authentication
@ -82,6 +80,7 @@ Extend and modify how users are authenticated on your homeserver.
| [matrix-ldap-registration-proxy](https://gitlab.com/activism.international/matrix_ldap_registration_proxy) (advanced) | x | A proxy that handles Matrix registration requests and forwards them to LDAP. | [Link](docs/configuring-playbook-matrix-ldap-registration-proxy.md) |
| [matrix-registration](https://github.com/ZerataX/matrix-registration) | x | A simple python application to have a token based Matrix registration | [Link](docs/configuring-playbook-matrix-registration.md) |
| [Matrix User Verification Service](https://github.com/matrix-org/matrix-user-verification-service) (UVS) | x | Service to verify details of a user based on an Open ID token | [Link](docs/configuring-playbook-user-verification-service.md) |
| [synapse-simple-antispam](https://github.com/t2bot/synapse-simple-antispam) (advanced) | x | A spam checker module | [Link](docs/configuring-playbook-synapse-simple-antispam.md) |
### File Storage
@ -162,19 +161,20 @@ Services that help you in administrating and monitoring your Matrix installation
### Misc
Various services that don't fit any other category.
Various services that don't fit any other categories.
| Name | Default? | Description | Documentation |
| ---- | -------- | ----------- | ------------- |
| [sliding-sync](https://github.com/matrix-org/sliding-sync)| x | Sliding Sync support for clients which require it (e.g. Element X) | [Link](docs/configuring-playbook-sliding-sync-proxy.md) |
| [synapse_auto_accept_invite](https://github.com/matrix-org/synapse-auto-accept-invite) | x | A Synapse module to automatically accept invites. | [Link](docs/configuring-playbook-synapse-auto-accept-invite.md) |
| [synapse_auto_compressor](https://github.com/matrix-org/rust-synapse-compress-state/#automated-tool-synapse_auto_compressor) | x | A cli tool that automatically compresses `state_groups` database table in background. | [Link](docs/configuring-playbook-synapse-auto-compressor.md) |
| [synapse-simple-antispam](https://github.com/t2bot/synapse-simple-antispam) (advanced) | x | A spam checker module | [Link](docs/configuring-playbook-synapse-simple-antispam.md) |
| [Matrix Corporal](https://github.com/devture/matrix-corporal) (advanced) | x | Reconciliator and gateway for a managed Matrix server | [Link](docs/configuring-playbook-matrix-corporal.md) |
| [Etherpad](https://etherpad.org) | x | An open source collaborative text editor | [Link](docs/configuring-playbook-etherpad.md) |
| [Jitsi](https://jitsi.org/) | x | An open source video-conferencing platform | [Link](docs/configuring-playbook-jitsi.md) |
| [Cactus Comments](https://cactus.chat) | x | A federated comment system built on Matrix | [Link](docs/configuring-playbook-cactus-comments.md) |
| [Pantalaimon](https://github.com/matrix-org/pantalaimon) | x | An E2EE aware proxy daemon | [Link](docs/configuring-playbook-pantalaimon.md) |
| [Sygnal](https://github.com/matrix-org/sygnal) | x | Push gateway | [Link](docs/configuring-playbook-sygnal.md) |
| [ntfy](https://ntfy.sh) | x | Push notifications server | [Link](docs/configuring-playbook-ntfy.md) |
## Installation

5
docs/configuring-dns.md
View File

@ -93,8 +93,9 @@ This is an optional feature for the optionally-installed [ma1sd service](configu
**Note**: This `_matrix-identity._tcp` SRV record for the identity server is different from the `_matrix._tcp` that can be used for Synapse delegation. See [howto-server-delegation.md](howto-server-delegation.md) for more information about delegation.
When you're done with the DNS configuration and ready to proceed, continue with [Getting the playbook](getting-the-playbook.md).
## `_dmarc`, `postmoogle._domainkey` TXT and `matrix` MX records setup
To make the [postmoogle](configuring-playbook-bridge-postmoogle.md) email bridge enable its email sending features, you need to configure SPF (TXT), DMARC (TXT), DKIM (TXT) and MX records
---
When you're done with the DNS configuration and ready to proceed, continue with [Getting the playbook](getting-the-playbook.md).

4
docs/configuring-playbook-bridge-mautrix-telegram.md
View File

@ -71,3 +71,7 @@ If you like to exclude all groups from syncing and use the Telgeram-Bridge only
```yaml
matrix_mautrix_telegram_filter_mode: whitelist
```
If you like to enable specific Group/Channels, use:
`!filter whitelist <chat ID>` --> only Bot-Admins are able to do that!
To get the chat-ID you can use this [TG-BOT](https://t.me/username_to_id_bot) or options listed [here](https://github.com/GabrielRF/telegram-id).

116
docs/configuring-playbook.md
View File

@ -31,18 +31,6 @@ When you're done with all the configuration you'd like to do, continue with [Ins
## Other configuration options
### Additional useful services
- [Setting up the Jitsi video-conferencing platform](configuring-playbook-jitsi.md)
- [Setting up Etherpad](configuring-playbook-etherpad.md)
- [Enabling metrics and graphs (Prometheus, Grafana) for your Matrix server](configuring-playbook-prometheus-grafana.md)
- [Enabling metrics and graphs for NginX logs](docs/configuring-playbook-prometheus-nginxlog.md)
- [Enabling synapse-usage-exporter for Synapse usage statistics](configuring-playbook-synapse-usage-exporter.md)
### Core service adjustments
- Homeserver configuration:
@ -52,52 +40,50 @@ When you're done with all the configuration you'd like to do, continue with [Ins
- [Configuring Dendrite](configuring-playbook-dendrite.md), if you've switched to the [Dendrite](https://matrix-org.github.io/dendrite) homeserver implementation
- [Configuring Element](configuring-playbook-client-element.md)
- Server components:
- [Using an external PostgreSQL server](configuring-playbook-external-postgres.md)
- [Storing Matrix media files using matrix-media-repo](configuring-playbook-matrix-media-repo.md)
- [Adjusting TURN server configuration](configuring-playbook-turn.md) (advanced)
- [Storing Synapse media files on Amazon S3 or another compatible Object Storage](configuring-playbook-s3.md)
- [Configuring the Traefik reverse-proxy](configuring-playbook-traefik.md) (advanced)
- [Storing Matrix media files on Amazon S3 with Goofys](docs/configuring-playbook-s3-goofys.md)
- [Using your own webserver, instead of this playbook's Traefik reverse-proxy](configuring-playbook-own-webserver.md) (advanced)
- [Using an external PostgreSQL server](configuring-playbook-external-postgres.md)
- [Adjusting SSL certificate retrieval](configuring-playbook-ssl-certificates.md) (advanced)
- [Adjusting SSL certificate retrieval](configuring-playbook-ssl-certificates.md) (advanced)
- [Adjusting email-sending settings](configuring-playbook-email.md)
- [Setting up ma1sd Identity Server](configuring-playbook-ma1sd.md)
- [Setting up Dynamic DNS](configuring-playbook-dynamic-dns.md)
- Server connectivity:
- [Enabling Telemetry for your Matrix server](configuring-playbook-telemetry.md)
- [Controlling Matrix federation](configuring-playbook-federation.md)
- [Serving the base domain](configuring-playbook-base-domain-serving.md)
- [Configuring the Traefik reverse-proxy](configuring-playbook-traefik.md) (advanced)
### Clients
- [Using your own webserver, instead of this playbook's Traefik reverse-proxy](configuring-playbook-own-webserver.md) (advanced)
Web clients for Matrix that you can host on your own domains.
- [Adjusting TURN server configuration](configuring-playbook-turn.md) (advanced)
- [Configuring Element](configuring-playbook-client-element.md), if you're going with the default/recommended client
- [Setting up Hydrogen](configuring-playbook-client-hydrogen.md), if you've enabled [Hydrogen](https://github.com/element-hq/hydrogen-web), a lightweight Matrix client with legacy and mobile browser support
### Server connectivity
- [Enabling Telemetry for your Matrix server](configuring-playbook-telemetry.md)
- [Controlling Matrix federation](configuring-playbook-federation.md)
- [Adjusting email-sending settings](configuring-playbook-email.md)
- [Setting up Dynamic DNS](configuring-playbook-dynamic-dns.md)
- [Setting up Hydrogen](configuring-playbook-client-hydrogen.md) - a new lightweight Matrix client with legacy and mobile browser support
- [Setting up Cinny](configuring-playbook-client-cinny.md) - a web client focusing primarily on simple, elegant and secure interface
- [Setting up SchildiChat](configuring-playbook-client-schildichat.md) - a web client based on [Element](https://element.io/) with some extras and tweaks
- [Setting up Cinny](configuring-playbook-client-cinny.md), if you've enabled [Cinny](https://github.com/ajbura/cinny), a web client focusing primarily on simple, elegant and secure interface
- [Setting up SchildiChat](configuring-playbook-client-schildichat.md), if you've enabled [SchildiChat](https://schildi.chat/), a web client based on [Element](https://element.io/) with some extras and tweaks
### Authentication and user-related
Extend and modify how users are authenticated on your homeserver.
- [Setting up Matrix Authentication Service](configuring-playbook-matrix-authentication-service.md) (Next-generation auth for Matrix, based on OAuth 2.0/OIDC)
- [Setting up Appservice Double Puppet](configuring-playbook-appservice-double-puppet.md)
- [Setting up ma1sd Identity Server](configuring-playbook-ma1sd.md)
- [Setting up Synapse Admin](configuring-playbook-synapse-admin.md)
- [Setting up matrix-registration](configuring-playbook-matrix-registration.md)
@ -112,15 +98,22 @@ When you're done with all the configuration you'd like to do, continue with [Ins
- [Setting up Synapse Simple Antispam](configuring-playbook-synapse-simple-antispam.md) (advanced)
- [Setting up Matrix Corporal](configuring-playbook-matrix-corporal.md) (advanced)
- [Setting up Matrix User Verification Service](configuring-playbook-user-verification-service.md) (advanced)
- [Setting up Pantalaimon (E2EE aware proxy daemon)](configuring-playbook-pantalaimon.md) (advanced)
### File Storage
Use alternative file storage to the default `media_store` folder.
- [Storing Matrix media files on Amazon S3 with Goofys](docs/configuring-playbook-s3-goofys.md)
- [Storing Synapse media files on Amazon S3 or another compatible Object Storage](configuring-playbook-s3.md)
- [Storing Matrix media files using matrix-media-repo](configuring-playbook-matrix-media-repo.md)
### Bridging other networks
Bridges can be used to connect your Matrix installation with third-party communication networks.
- [Setting up Mautrix Discord bridging](configuring-playbook-bridge-mautrix-discord.md)
- [Setting up Mautrix Telegram bridging](configuring-playbook-bridge-mautrix-telegram.md)
@ -182,6 +175,8 @@ When you're done with all the configuration you'd like to do, continue with [Ins
### Bots
Bots provide various additional functionality to your installation.
- [Setting up baibot](configuring-playbook-bot-baibot.md) - a bot through which you can talk to various [AI](https://en.wikipedia.org/wiki/Artificial_intelligence) / [Large Language Models](https://en.wikipedia.org/wiki/Large_language_model) services ([OpenAI](https://openai.com/)'s [ChatGPT](https://openai.com/blog/chatgpt/) and [others](https://github.com/etkecc/baibot/blob/main/docs/providers.md))
- [Setting up matrix-reminder-bot](configuring-playbook-bot-matrix-reminder-bot.md) - a bot to remind you about stuff
@ -200,32 +195,49 @@ When you're done with all the configuration you'd like to do, continue with [Ins
- [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
### Administration
### Backups
Services that help you in administrating and monitoring your Matrix installation.
- [Setting up BorgBackup](configuring-playbook-backup-borg.md) - a full Matrix server backup solution, including the Postgres database
- [Setting up Prometheus Alertmanager integration via matrix-alertmanager-receiver](configuring-playbook-alertmanager-receiver.md)
- [Setting up postgres backup](configuring-playbook-postgres-backup.md) - a Postgres-database backup solution (note: does not include other files)
- [Enabling metrics and graphs (Prometheus, Grafana) for your Matrix server](configuring-playbook-prometheus-grafana.md)
- [Enabling metrics and graphs for NginX logs](docs/configuring-playbook-prometheus-nginxlog.md)
- [Setting up the rageshake bug report server](configuring-playbook-rageshake.md)
- [Enabling synapse-usage-exporter for Synapse usage statistics](configuring-playbook-synapse-usage-exporter.md)
- Backups:
- [Setting up BorgBackup](configuring-playbook-backup-borg.md) - a full Matrix server backup solution, including the Postgres database
- [Setting up postgres backup](configuring-playbook-postgres-backup.md) - a Postgres-database backup solution (note: does not include other files)
### Other specialized services
- [Setting up synapse-auto-compressor](configuring-playbook-synapse-auto-compressor.md) for compressing the database on Synapse homeservers
Various services that don't fit any other categories.
- [Setting up the Sliding Sync proxy](configuring-playbook-sliding-sync-proxy.md) for clients which require Sliding Sync support (like Element X)
- [Setting up Synapse Auto Invite Accept](configuring-playbook-synapse-auto-accept-invite.md)
- [Setting up the Sliding Sync proxy](configuring-playbook-sliding-sync-proxy.md) for clients which require Sliding Sync support (like Element X)
- [Setting up synapse-auto-compressor](configuring-playbook-synapse-auto-compressor.md) for compressing the database on Synapse homeservers
- [Setting up Matrix Corporal](configuring-playbook-matrix-corporal.md) (advanced)
- [Setting up Etherpad](configuring-playbook-etherpad.md)
- [Setting up the Jitsi video-conferencing platform](configuring-playbook-jitsi.md)
- [Setting up Cactus Comments](configuring-playbook-cactus-comments.md) - a federated comment system built on Matrix
- [Setting up Pantalaimon (E2EE aware proxy daemon)](configuring-playbook-pantalaimon.md) (advanced)
- [Setting up the Sygnal push gateway](configuring-playbook-sygnal.md)
- [Setting up the ntfy push notifications server](configuring-playbook-ntfy.md)
- [Setting up Cactus Comments](configuring-playbook-cactus-comments.md) - a federated comment system built on Matrix
- [Setting up the rageshake bug report server](configuring-playbook-rageshake.md)
- [Setting up Prometheus Alertmanager integration via matrix-alertmanager-receiver](configuring-playbook-alertmanager-receiver.md)
### Deprecated / unmaintained / removed services
**Note**: since a deprecated or unmaintained service will not be updated, its bug or vulnerability will be unlikely to get patched. It is recommended to migrate from the service to an alternative if any, and make sure to do your own research before you decide to keep it running nonetheless.

24
docs/container-images.md
View File

@ -15,6 +15,8 @@ We try to stick to official images (provided by their respective projects) as mu
## Clients
Web clients for Matrix that you can host on your own domains.
| Service | Container image | Default? | Description |
| ------- | --------------- | -------- | ----------- |
| [Element](configuring-playbook-client-element.md) | [vectorim/element-web](https://hub.docker.com/r/vectorim/element-web/) | ✓ | Web UI, which is configured to connect to your own Synapse server by default |
@ -24,20 +26,22 @@ We try to stick to official images (provided by their respective projects) as mu
## Server Components
Services that run on the server to make the various parts of your installation work.
| Service | Container image | Default? | Description |
| ------- | --------------- | -------- | ----------- |
| [PostgreSQL](configuring-playbook-external-postgres.md) | [postgres](https://hub.docker.com/_/postgres/) | ✓ | Database for Synapse. [Using an external PostgreSQL server](configuring-playbook-external-postgres.md) is also possible. |
| [Coturn](configuring-playbook-turn.md) | [coturn/coturn](https://hub.docker.com/r/coturn/coturn/) | ✓ | STUN/TURN server for WebRTC audio/video calls |
| [Traefik](configuring-playbook-traefik.md) | [Traefik](https://hub.docker.com/_/traefik/) | ✓ | Web server, listening on ports 80, 443 and 8448 - standing in front of all the other services. Using your own webserver [is possible](configuring-playbook-own-webserver.md) |
| [Let's Encrypt](configuring-playbook-ssl-certificates.md) | [certbot/certbot](https://hub.docker.com/r/certbot/certbot/) | ✓ | The [certbot](https://certbot.eff.org/) tool for obtaining SSL certificates from [Let's Encrypt](https://letsencrypt.org/) |
| [ma1sd](configuring-playbook-ma1sd.md) | [ma1uta/ma1sd](https://hub.docker.com/r/ma1uta/ma1sd/) | x | Matrix Identity Server |
| [Exim](configuring-playbook-email.md) | [devture/exim-relay](https://hub.docker.com/r/devture/exim-relay/) | ✓ | Mail server, through which all Matrix services send outgoing email (can be configured to relay through another SMTP server) |
| [ma1sd](configuring-playbook-ma1sd.md) | [ma1uta/ma1sd](https://hub.docker.com/r/ma1uta/ma1sd/) | x | Matrix Identity Server |
| [ddclient](configuring-playbook-dynamic-dns.md) | [linuxserver/ddclient](https://hub.docker.com/r/linuxserver/ddclient) | x | Update dynamic DNS entries for accounts on Dynamic DNS Network Service Provider |
| [Sygnal](configuring-playbook-sygnal.md) | [matrixdotorg/sygnal](https://hub.docker.com/r/matrixdotorg/sygnal/) | x | Reference Push Gateway for Matrix |
| [ntfy](configuring-playbook-ntfy.md) | [binwiederhier/ntfy](https://hub.docker.com/r/binwiederhier/ntfy/) | x | Self-hosted, UnifiedPush-compatible push notifications server |
## Authentication
Extend and modify how users are authenticated on your homeserver.
| Service | Container image | Default? | Description |
| ------- | --------------- | -------- | ----------- |
| [matrix-synapse-rest-auth](configuring-playbook-rest-auth.md) | (N/A) | x | REST authentication password provider module |
@ -46,9 +50,12 @@ We try to stick to official images (provided by their respective projects) as mu
| [matrix-ldap-registration-proxy](configuring-playbook-matrix-ldap-registration-proxy.md) | [activism.international/matrix_ldap_registration_proxy](https://gitlab.com/activism.international/matrix_ldap_registration_proxy/container_registry) | x | A proxy that handles Matrix registration requests and forwards them to LDAP. |
| [matrix-registration](configuring-playbook-matrix-registration.md) | [zeratax/matrix-registration](https://hub.docker.com/r/devture/zeratax-matrix-registration/) | x | A simple python application to have a token based Matrix registration |
| [Matrix User Verification Service](configuring-playbook-user-verification-service.md) (UVS) | [matrixdotorg/matrix-user-verification-service](https://hub.docker.com/r/atrixdotorg/matrix-user-verification-service) | x | Service to verify details of a user based on an Open ID token |
| [synapse-simple-antispam](configuring-playbook-synapse-simple-antispam.md) (advanced) | (N/A) | x | A spam checker module |
## File Storage
Use alternative file storage to the default `media_store` folder.
| Service | Container image | Default? | Description |
| ------- | --------------- | -------- | ----------- |
| [Goofys](configuring-playbook-s3-goofys.md) | [ewoutp/goofys](https://hub.docker.com/r/ewoutp/goofys/) | x | [Amazon S3](https://aws.amazon.com/s3/) (or other S3-compatible object store) storage for Synapse's content repository (`media_store`) files |
@ -57,6 +64,8 @@ We try to stick to official images (provided by their respective projects) as mu
# Bridges
Bridges can be used to connect your Matrix installation with third-party communication networks.
| Service | Container image | Default? | Description |
| ------- | --------------- | -------- | ----------- |
| [mautrix-discord](configuring-playbook-bridge-mautrix-discord.md) | [mautrix/discord](https://mau.dev/mautrix/discord/container_registry) | x | Bridge to [Discord](https://discord.com/) |
@ -90,6 +99,8 @@ We try to stick to official images (provided by their respective projects) as mu
## Bots
Bots provide various additional functionality to your installation.
| Service | Container image | Default? | Description |
| ------- | --------------- | -------- | ----------- |
| [baibot](configuring-playbook-bot-baibot.md) | [etke.cc/baibot](https://ghcr.io/etkecc/baibot) | x | A bot that exposes the power of [AI](https://en.wikipedia.org/wiki/Artificial_intelligence) / [Large Language Models](https://en.wikipedia.org/wiki/Large_language_model) to you |
@ -103,6 +114,8 @@ We try to stick to official images (provided by their respective projects) as mu
## Administration
Services that help you in administrating and monitoring your Matrix installation.
| Service | Container image | Default? | Description |
| ------- | --------------- | -------- | ----------- |
| [matrix-alertmanager-receiver](configuring-playbook-alertmanager-receiver.md) | [metio/matrix-alertmanager-receiver](https://hub.docker.com/r/metio/matrix-alertmanager-receiver) | x | Prometheus' [Alertmanager](https://prometheus.io/docs/alerting/latest/alertmanager/) client |
@ -118,12 +131,13 @@ We try to stick to official images (provided by their respective projects) as mu
## Misc
Various services that don't fit any other categories.
| Service | Container image | Default? | Description |
| ------- | --------------- | -------- | ----------- |
| [sliding-sync](configuring-playbook-sliding-sync-proxy.md) | [matrix-org/sliding-sync](https://ghcr.io/matrix-org/sliding-sync) | x | Sliding Sync support for clients which require it (e.g. Element X) |
| [synapse_auto_accept_invite](configuring-playbook-synapse-auto-accept-invite.md) | (N/A) | x | A Synapse module to automatically accept invites. |
| [synapse_auto_compressor](configuring-playbook-synapse-auto-compressor.md) | [etke.cc/rust-synapse-compress-state](https://gitlab.com/etke.cc/rust-synapse-compress-state/container_registry) | x | A cli tool that automatically compresses `state_groups` database table in background. |
| [synapse-simple-antispam](configuring-playbook-synapse-simple-antispam.md) (advanced) | (N/A) | x | A spam checker module |
| [Matrix Corporal](configuring-playbook-matrix-corporal.md) (advanced) | [devture/matrix-corporal](https://hub.docker.com/r/devture/matrix-corporal/) | x | Reconciliator and gateway for a managed Matrix server |
| [Etherpad](configuring-playbook-etherpad.md) | [etherpad/etherpad](https://hub.docker.com/r/etherpad/etherpad/) | x | An open source collaborative text editor |
| [Jitsi](configuring-playbook-jitsi.md) | [jitsi/web](https://hub.docker.com/r/jitsi/web) | x | the [Jitsi](https://jitsi.org/) web UI |
@ -133,6 +147,8 @@ We try to stick to official images (provided by their respective projects) as mu
| [Cactus Comments](configuring-playbook-cactus-comments.md) | [cactuscomments/cactus-appservice](https://hub.docker.com/r/cactuscomments/cactus-appservice/) | x | A federated comment system built on Matrix |
| [Cactus Comments](configuring-playbook-cactus-comments.md) | [joseluisq/static-web-server](https://hub.docker.com/r/joseluisq/static-web-server) | x | A federated comment system built on Matrix |
| [Pantalaimon](configuring-playbook-pantalaimon.md) | [matrixdotorg/pantalaimon](https://hub.docker.com/r/matrixdotorg/pantalaimon) | x | An E2EE aware proxy daemon |
| [Sygnal](configuring-playbook-sygnal.md) | [matrixdotorg/sygnal](https://hub.docker.com/r/matrixdotorg/sygnal/) | x | Reference Push Gateway for Matrix |
| [ntfy](configuring-playbook-ntfy.md) | [binwiederhier/ntfy](https://hub.docker.com/r/binwiederhier/ntfy/) | x | Self-hosted, UnifiedPush-compatible push notifications server |
## Container images of deprecated / unmaintained services