mirror of
https://github.com/spantaleev/matrix-docker-ansible-deploy.git
synced 2024-11-14 22:42:51 +01:00
b04b658735
* Replace "Element" with "Element Web" - If Element indicates the web application, then it is changed to Element Web. - If it indicates clients branded with Element such as Element desktop, web, mobile clients, then it is changed to Element clients. - If it is combined with location sharing functionality, it is not changed. with other some changes, including: - Change "app.element.io" anchor link to "https://github.com/element-hq/element-web" on README.md, following other documentation files Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Replace "SchildiChat" with "SchildiChat Web" - If SchildiChat indicates the web application, then it is changed to SchildiChat Web. - If it indicates clients branded with SchildiChat such as SchildiChat desktop, web, mobile clients, then it is changed to SchildiChat clients. - If it is combined with location sharing functionality, it is not changed. Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Rename configuring-playbook-client-schildichat.md to configuring-playbook-client-schildichat-web.md Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> * Rename configuring-playbook-client-element.md to configuring-playbook-client-element-web.md Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> --------- Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org> Co-authored-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
21 KiB
21 KiB
Container images used by the playbook
This page summarizes the container (Docker) images used by the playbook when setting up your server.
We try to stick to official images (provided by their respective projects) as much as possible.
Homeserver
| Service | Container image | Default? | Description |
|---|---|---|---|
| Synapse | element-hq/synapse | ✓ | Storing your data and managing your presence in the Matrix network |
| Conduit | matrixconduit/matrix-conduit | x | Storing your data and managing your presence in the Matrix network. Conduit is a lightweight open-source server implementation of the Matrix Specification with a focus on easy setup and low system requirements |
| Dendrite | matrixdotorg/dendrite-monolith | x | Storing your data and managing your presence in the Matrix network. Dendrite is a second-generation Matrix homeserver written in Go, an alternative to Synapse. |
Clients
Web clients for Matrix that you can host on your own domains.
| Service | Container image | Default? | Description |
|---|---|---|---|
| Element Web | vectorim/element-web | ✓ | Default Matrix web client, configured to connect to your own Synapse server |
| Hydrogen | element-hq/hydrogen-web | x | Lightweight Matrix client with legacy and mobile browser support |
| Cinny | ajbura/cinny | x | Simple, elegant and secure web client |
| SchildiChat Web | etke.cc/schildichat-web | x | Based on Element Web, with a more traditional instant messaging experience |
Server Components
Services that run on the server to make the various parts of your installation work.
| Service | Container image | Default? | Description |
|---|---|---|---|
| PostgreSQL | postgres | ✓ | Database for Synapse. Using an external PostgreSQL server is also possible. |
| Coturn | coturn/coturn | ✓ | STUN/TURN server for WebRTC audio/video calls |
| Traefik | Traefik | ✓ | Web server, listening on ports 80, 443 and 8448 - standing in front of all the other services. Using your own webserver is possible |
| Let's Encrypt | certbot/certbot | ✓ | The certbot tool for obtaining SSL certificates from Let's Encrypt |
| Exim | devture/exim-relay | ✓ | Mail server, through which all Matrix services send outgoing email (can be configured to relay through another SMTP server) |
| ma1sd | ma1uta/ma1sd | x | Matrix Identity Server |
| ddclient | linuxserver/ddclient | x | Update dynamic DNS entries for accounts on Dynamic DNS Network Service Provider |
Authentication
Extend and modify how users are authenticated on your homeserver.
| Service | Container image | Default? | Description |
|---|---|---|---|
| matrix-synapse-rest-auth | (N/A) | x | REST authentication password provider module |
| matrix-synapse-shared-secret-auth | (N/A) | x | Password provider module |
| matrix-synapse-ldap3 (advanced) | (N/A) | x | LDAP Auth password provider module |
| matrix-ldap-registration-proxy | activism.international/matrix_ldap_registration_proxy | x | A proxy that handles Matrix registration requests and forwards them to LDAP. |
| matrix-registration | zeratax/matrix-registration | x | A simple python application to have a token based Matrix registration |
| Matrix User Verification Service (UVS) | matrixdotorg/matrix-user-verification-service | x | Service to verify details of a user based on an Open ID token |
| synapse-simple-antispam (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 | ewoutp/goofys | x | Amazon S3 (or other S3-compatible object store) storage for Synapse's content repository (media_store) files |
| synapse-s3-storage-provider | (N/A) | x | Amazon S3 (or other S3-compatible object store) storage for Synapse's content repository (media_store) files |
| matrix-media-repo | t2bot/matrix-media-repo | x | matrix-media-repo is a highly customizable multi-domain media repository for Matrix. Intended for medium to large deployments, this media repo de-duplicates media while being fully compliant with the specification. |
Bridges
Bridges can be used to connect your Matrix installation with third-party communication networks.
Bots
Bots provide various additional functionality to your installation.
| Service | Container image | Default? | Description |
|---|---|---|---|
| baibot | etke.cc/baibot | x | A bot that exposes the power of AI / Large Language Models to you |
| matrix-reminder-bot | anoa/matrix-reminder-bot | x | Bot for scheduling one-off & recurring reminders and alarms |
| matrix-registration-bot | moanos/matrix-registration-bot | x | Bot for invitations by creating and managing registration tokens |
| maubot | dock.mau.dev/maubot/maubot | x | A plugin-based Matrix bot system |
| Honoroit | etke.cc/honoroit | x | A helpdesk bot |
| Mjolnir | matrixdotorg/mjolnir | x | A moderation tool for Matrix |
| Draupnir | gnuxie/draupnir | x | A moderation tool for Matrix (Fork of Mjolnir) |
| Buscarron | etke.cc/buscarron | x | Web forms (HTTP POST) to Matrix |
Administration
Services that help you in administrating and monitoring your Matrix installation.
| Service | Container image | Default? | Description |
|---|---|---|---|
| matrix-alertmanager-receiver | metio/matrix-alertmanager-receiver | x | Prometheus' Alertmanager client |
| Matrix Authentication Service | element-hq/matrix-authentication-service | x | OAuth 2.0 and OpenID Provider server |
| synapse-admin | etke.cc/synapse-admin | x | A web UI tool for administrating users and rooms on your Matrix server |
| Metrics and Graphs | prom/prometheus | x | Prometheus time-series database server |
| Metrics and Graphs | prom/node-exporter | x | Prometheus node-exporter host metrics exporter |
| Metrics and Graphs | grafana/grafana | x | Graphing tool that works well with the above two images. Our playbook also adds two dashboards for Synapse and Node Exporter |
| Metrics and Graphs | martin-helmich/prometheus-nginxlog-exporter/exporter | x | Addon for Prometheus that gathers access logs from various nginx reverse-proxies |
| Borg | (N/A) | x | Backups |
| rageshake | matrix-org/rageshake | x | Bug report server |
| synapse-usage-exporter | Self-building | x | Export the usage statistics of a Synapse homeserver to be scraped by Prometheus. |
Misc
Various services that don't fit any other categories.
| Service | Container image | Default? | Description |
|---|---|---|---|
| sliding-sync | matrix-org/sliding-sync | x | Sliding Sync support for clients which require it (like old Element X versions, before it got switched to Simplified Sliding Sync) |
| synapse_auto_accept_invite | (N/A) | x | A Synapse module to automatically accept invites. |
| synapse_auto_compressor | etke.cc/rust-synapse-compress-state | x | A cli tool that automatically compresses state_groups database table in background. |
| Matrix Corporal (advanced) | devture/matrix-corporal | x | Reconciliator and gateway for a managed Matrix server |
| Etherpad | etherpad/etherpad | x | An open source collaborative text editor |
| Jitsi | jitsi/web | x | the Jitsi web UI |
| Jitsi | jitsi/jicofo | x | the Jitsi Focus component |
| Jitsi | jitsi/prosody | x | the Jitsi Prosody XMPP server component |
| Jitsi | jitsi/jvb | x | the Jitsi Video Bridge component |
| Cactus Comments | cactuscomments/cactus-appservice | x | A federated comment system built on Matrix |
| Cactus Comments | joseluisq/static-web-server | x | A federated comment system built on Matrix |
| Pantalaimon | matrixdotorg/pantalaimon | x | An E2EE aware proxy daemon |
| Sygnal | matrixdotorg/sygnal | x | Reference Push Gateway for Matrix |
| ntfy | binwiederhier/ntfy | x | Self-hosted, UnifiedPush-compatible push notifications server |
Container images of deprecated / unmaintained services
The list of the deprecated or unmaintained services is available here.
| Service | Container image | Default? | Description |
|---|---|---|---|
| matrix-appservice-webhooks | turt2live/matrix-appservice-webhooks | x | Bridge for slack compatible webhooks (ConcourseCI, Slack etc. pp.) |
| Dimension | turt2live/matrix-dimension | x | An open source integration manager for Matrix clients |
| Go-NEB | matrixdotorg/go-neb | x | A multi functional bot written in Go |
| matrix-chatgpt-bot | matrixgpt/matrix-chatgpt-bot | x | Accessing ChatGPT via your favourite Matrix client |
| mautrix-facebook | mautrix/facebook | x | Bridge to Facebook |
| mautrix-hangouts | mautrix/hangouts | x | Bridge to Google Hangouts |
| mautrix-instagram | mautrix/instagram | x | Bridge to Instagram |