Matrix/matrix-docker-ansible-deploy
1
0
Fork 0
mirror of https://github.com/spantaleev/matrix-docker-ansible-deploy.git synced 2024-11-14 10:04:46 +08:00
Code Issues Packages Projects Releases Wiki Activity
ab1cce5a14
matrix-docker-ansible-deploy/docs/container-images.md
Suguru Hirahara ab1cce5a14
Update docs/container-images.md: create a table for Authentication 
Signed-off-by: Suguru Hirahara <acioustick@noreply.codeberg.org>
2024-11-01 22:35:25 +09:00

18 KiB
Raw Blame History

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

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.