1
0
mirror of https://github.com/spantaleev/matrix-docker-ansible-deploy.git synced 2024-12-12 08:43:55 +02:00
matrix-docker-ansible-deploy/docs/container-images.md
Suguru Hirahara 292dd56eed
Update docs/container-images.md: create a table for Bots
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-01 22:35:39 +09:00

20 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

Service Container image Default? Description
Element vectorim/element-web Web UI, which is configured to connect to your own Synapse server by default
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 etke.cc/schildichat-web x Based on Element, with a more traditional instant messaging experience

Server Components

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
ma1sd ma1uta/ma1sd x Matrix Identity Server
Exim devture/exim-relay Mail server, through which all Matrix services send outgoing email (can be configured to relay through another SMTP server)
ddclient linuxserver/ddclient x Update dynamic DNS entries for accounts on Dynamic DNS Network Service Provider
Sygnal matrixdotorg/sygnal x Reference Push Gateway for Matrix
ntfy binwiederhier/ntfy x Self-hosted, UnifiedPush-compatible push notifications server

Authentication

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

File Storage

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

Service Container image Default? Description
mautrix-discord mautrix/discord x Bridge to Discord
mautrix-slack mautrix/slack x Bridge to Slack
mautrix-telegram mautrix/telegram x Bridge to Telegram
mautrix-gmessages mautrix/gmessages x Bridge to Google Messages
mautrix-whatsapp mautrix/whatsapp x Bridge to WhatsApp
mautrix-wsproxy mautrix/wsproxy x Bridge to Android SMS or Apple iMessage
mautrix-twitter mautrix/twitter x Bridge to Twitter
mautrix-googlechat mautrix/googlechat x Bridge to Google Chat
mautrix-meta (for Messenger and Instagram) mautrix/meta x Bridge to Messenger and Instagram
mautrix-signal mautrix/signal x Bridge to Signal
beeper-linkedin beeper/linkedin x Bridge to LinkedIn
matrix-appservice-irc matrixdotorg/matrix-appservice-irc x Bridge to IRC
matrix-appservice-kakaotalk Self-building x Bridge to Kakaotalk
matrix-appservice-discord matrix-org/matrix-appservice-discord x Bridge to Discord
matrix-appservice-slack matrixdotorg/matrix-appservice-slack x Bridge to Slack
matrix-hookshot halfshot/matrix-hookshot x Bridge for generic webhooks and multiple project management services, such as GitHub, GitLab, Figma, and Jira in particular
matrix-sms-bridge folivonet/matrix-sms-bridge x Bridge to SMS
matrix-wechat lxduo/matrix-wechat x Bridge to WeChat
Heisenbridge hif1/heisenbridge x Bouncer-style bridge to IRC
go-skype-bridge nodefyme/go-skype-bridge x Bridge to Skype
mx-puppet-slack mx-puppet/slack/mx-puppet-slack x Bridge to Slack
mx-puppet-instagram sorunome/mx-puppet-instagram x Bridge for Instagram-DMs (Instagram)
mx-puppet-twitter sorunome/mx-puppet-twitter x Bridge for Twitter-DMs (Twitter)
mx-puppet-discord mx-puppet/discord/mx-puppet-discord x Bridge to Discord
mx-puppet-groupme xangelix/mx-puppet-groupme x Bridge to GroupMe
mx-puppet-steam icewind1991/mx-puppet-steam x Bridge to Steam
Email2Matrix devture/email2matrix x Bridge for relaying emails to Matrix rooms
Postmoogle etke.cc/postmoogle x Email to Matrix bridge

Bots

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

Optional other container images we may use

These services are not part of our default installation, but can be enabled by configuring the playbook (either before the initial installation or any time later):

Container images of deprecated / unmaintained services

The list of the deprecated or unmaintained services is available here.