matrix-docker-ansible-deploy
🐳 Matrix (An open network for secure, decentralized communication) server setup using Ansible and Docker
Top Related Projects
Synapse: Matrix homeserver written in Python/Twisted.
bridge between mattermost, IRC, gitter, xmpp, slack, discord, telegram, rocketchat, twitch, ssh-chat, zulip, whatsapp, keybase, matrix, microsoft teams, nextcloud, mumble, vk and more with REST API (mattermost not required!)
A glossy Matrix collaboration client for the web.
A Matrix-WhatsApp puppeting bridge
Mattermost is an open source platform for secure collaboration across the entire software development lifecycle..
Dendrite is a second-generation Matrix homeserver written in Go!
Quick Overview
The matrix-docker-ansible-deploy project is an Ansible playbook for deploying a Matrix homeserver and related services using Docker. It provides a comprehensive, customizable, and automated solution for setting up a Matrix server environment, including various bridges, bots, and additional components.
Pros
- Comprehensive and feature-rich, supporting a wide range of Matrix-related services and components
- Highly customizable, allowing users to tailor their Matrix deployment to their specific needs
- Well-documented, with detailed instructions and explanations for various deployment scenarios
- Actively maintained and regularly updated to incorporate new features and improvements
Cons
- Requires some technical knowledge of Ansible, Docker, and server administration
- Can be complex to set up and configure, especially for users new to Matrix or self-hosting
- May require significant server resources depending on the chosen components and expected user load
- Potential for compatibility issues or conflicts between different components or versions
Getting Started
To get started with matrix-docker-ansible-deploy:
- Ensure you have a server with a supported OS (e.g., Debian 10/11, Ubuntu 20.04/22.04)
- Install Ansible on your local machine
- Clone the repository:
git clone https://github.com/spantaleev/matrix-docker-ansible-deploy.git
- Copy
inventory/host_vars/matrix.DOMAIN/vars.yml.example
toinventory/host_vars/matrix.DOMAIN/vars.yml
- Edit
vars.yml
to configure your deployment - Run the playbook:
ansible-playbook -i inventory/hosts setup.yml --tags=setup-all,start
For detailed instructions and customization options, refer to the project's documentation.
Competitor Comparisons
Synapse: Matrix homeserver written in Python/Twisted.
Pros of Synapse
- Official reference implementation of the Matrix protocol
- Highly customizable and feature-rich
- Active development and regular updates from the Matrix.org team
Cons of Synapse
- Requires more manual configuration and setup
- Can be resource-intensive, especially for larger deployments
- Steeper learning curve for beginners
Code Comparison
Synapse configuration (homeserver.yaml):
server_name: "example.com"
listeners:
- port: 8008
tls: false
type: http
x_forwarded: true
resources:
- names: [client, federation]
compress: false
matrix-docker-ansible-deploy configuration (inventory/host_vars/matrix.example.com/vars.yml):
matrix_domain: example.com
matrix_synapse_container_image_tag: v1.59.1
matrix_nginx_proxy_enabled: true
matrix_ssl_lets_encrypt_enabled: true
matrix_coturn_enabled: true
The matrix-docker-ansible-deploy project simplifies the deployment process by using Ansible and Docker, making it easier to set up and maintain a Matrix homeserver. It provides a more streamlined approach compared to the manual configuration required for Synapse. However, Synapse offers more flexibility and control over individual components, which may be preferred by advanced users or those with specific requirements.
bridge between mattermost, IRC, gitter, xmpp, slack, discord, telegram, rocketchat, twitch, ssh-chat, zulip, whatsapp, keybase, matrix, microsoft teams, nextcloud, mumble, vk and more with REST API (mattermost not required!)
Pros of Matterbridge
- Supports a wide range of chat platforms and protocols, not limited to Matrix
- Lightweight and can be run as a single binary
- Easier to set up for simple bridging scenarios
Cons of Matterbridge
- Less integrated with the Matrix ecosystem
- Requires manual configuration for each bridge
- Limited to bridging functionality, doesn't provide a full Matrix server deployment
Code Comparison
Matterbridge configuration (TOML):
[matrix]
[matrix.example]
Server="https://matrix.org"
Login="username"
Password="password"
RoomID="!roomid:matrix.org"
[irc]
[irc.freenode]
Server="irc.freenode.net:6667"
Nick="MyBot"
Channel="#channel"
matrix-docker-ansible-deploy configuration (YAML):
matrix_synapse_enabled: true
matrix_nginx_proxy_enabled: true
matrix_bridges_mautrix_telegram_enabled: true
matrix_bridges_mautrix_whatsapp_enabled: true
The matrix-docker-ansible-deploy project provides a more comprehensive Matrix server deployment solution, while Matterbridge focuses solely on bridging between different chat platforms. The configuration styles reflect their different scopes and approaches to chat integration.
A glossy Matrix collaboration client for the web.
Pros of element-web
- Direct implementation of the Element web client, offering the latest features and updates
- Focused solely on the web interface, allowing for easier customization and theming
- Extensive documentation and active community support
Cons of element-web
- Requires separate setup and configuration of the Matrix server
- Less comprehensive solution for those looking to deploy a full Matrix ecosystem
- May require more technical expertise to integrate with other Matrix components
Code Comparison
element-web (React component):
export default class MatrixChat extends React.PureComponent {
static displayName = 'MatrixChat'
constructor(props) {
super(props);
this.state = {
view: VIEWS.LOADING,
};
}
}
matrix-docker-ansible-deploy (Ansible task):
- name: Ensure Matrix Synapse is installed
ansible.builtin.apt:
name: matrix-synapse
state: present
when: matrix_synapse_enabled | bool
The element-web repository focuses on the client-side implementation using React, while matrix-docker-ansible-deploy uses Ansible for server-side deployment and configuration.
A Matrix-WhatsApp puppeting bridge
Pros of mautrix/whatsapp
- Focused specifically on WhatsApp integration with Matrix
- Lightweight and can be deployed independently
- Actively maintained with frequent updates
Cons of mautrix/whatsapp
- Limited to WhatsApp bridge functionality
- Requires separate setup and configuration for full Matrix server deployment
- May need additional components for a complete Matrix ecosystem
Code Comparison
matrix-docker-ansible-deploy (Ansible playbook excerpt):
- name: Ensure matrix-synapse is installed
ansible.builtin.apt:
name: matrix-synapse
state: present
- name: Configure matrix-synapse
ansible.builtin.template:
src: homeserver.yaml.j2
dest: /etc/matrix-synapse/homeserver.yaml
mautrix/whatsapp (Go code excerpt):
func (bridge *Bridge) Start() {
bridge.Log.Infoln("Starting bridge")
bridge.AS.Start()
bridge.DB.Upgrade()
bridge.startUsers()
bridge.Log.Infoln("Bridge started!")
}
The code snippets highlight the different focus areas of the two projects. matrix-docker-ansible-deploy provides a comprehensive setup for a Matrix server, while mautrix/whatsapp concentrates on the WhatsApp bridge functionality.
Mattermost is an open source platform for secure collaboration across the entire software development lifecycle..
Pros of Mattermost
- Built-in team collaboration features like channels, direct messaging, and file sharing
- Extensive integration options with third-party tools and services
- User-friendly web and mobile interfaces for easy adoption
Cons of Mattermost
- Less flexible for custom deployments compared to Matrix-based solutions
- May require more resources to run, especially for larger installations
- Limited end-to-end encryption options compared to Matrix
Code Comparison
Matrix-docker-ansible-deploy:
- name: Ensure Matrix Synapse is installed
ansible.builtin.apt:
name: matrix-synapse
state: present
- name: Configure Matrix Synapse
ansible.builtin.template:
src: homeserver.yaml.j2
dest: /etc/matrix-synapse/homeserver.yaml
Mattermost:
func (a *App) CreateDefaultChannels(teamID string) ([]*model.Channel, error) {
channels := []*model.Channel{}
defaultChannelNames := []string{"town-square", "off-topic"}
for _, name := range defaultChannelNames {
channel := &model.Channel{DisplayName: name, Name: name, Type: model.CHANNEL_OPEN, TeamId: teamID}
channels = append(channels, channel)
}
return channels, nil
}
The code snippets showcase different aspects of each project. Matrix-docker-ansible-deploy uses Ansible for deployment and configuration, while Mattermost is written in Go and focuses on application logic for creating default channels.
Dendrite is a second-generation Matrix homeserver written in Go!
Pros of Dendrite
- Written in Go, offering potential performance benefits and easier scalability
- Designed as a next-generation homeserver implementation with a focus on efficiency
- Modular architecture allowing for easier customization and maintenance
Cons of Dendrite
- Less mature and battle-tested compared to Synapse (the default homeserver in matrix-docker-ansible-deploy)
- May have fewer features and integrations available out-of-the-box
- Potentially less documentation and community support
Code Comparison
matrix-docker-ansible-deploy (using Synapse):
matrix_synapse_container_image_name: "matrixdotorg/synapse"
matrix_synapse_container_image_tag: "v1.59.1"
Dendrite:
func main() {
cfg := config.Dendrite{}
cfg.SetDefaults()
cfg.Matrix.ServerName = "example.com"
}
The matrix-docker-ansible-deploy project uses Ansible to configure and deploy a Matrix homeserver (typically Synapse) along with various other components. It provides a comprehensive, production-ready setup with many additional features and integrations.
Dendrite, on the other hand, is a standalone Matrix homeserver implementation focused on performance and scalability. It's designed to be more efficient than Synapse but may require additional setup and configuration to achieve feature parity with a full matrix-docker-ansible-deploy installation.
Convert designs to code with AI
Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.
Try Visual CopilotREADME
Matrix (An open network for secure, decentralized communication) server setup using Ansible and Docker
Purpose
This Ansible playbook is meant to help you run your own Matrix homeserver, along with the various services related to that.
That is, it lets you join the Matrix network using your own @<username>:<your-domain>
identifier, all hosted on your own server (see prerequisites).
We run all services in Docker containers (see the container images we use), which lets us have a predictable and up-to-date setup, across multiple supported distros (see prerequisites) and architectures (x86/amd64 being recommended).
Installation (upgrades) and some maintenance tasks are automated using Ansible (see our Ansible guide).
Self-hosting or Managed / SaaS
This Ansible playbook tries to make self-hosting and maintaining a Matrix server fairly easy. Still, running any service smoothly requires knowledge, time and effort.
If you like the FOSS spirit of this Ansible playbook, but prefer to put the responsibility on someone else, you can also get a managed Matrix server from etke.cc (both hosting and on-premises) - a service built on top of this Ansible playbook but with additional components and services which all help you run a Matrix server with ease. Be advised that etke.cc operates on a subscription-based approach and there is no "just set up my server once and be done with it" option.
Supported services
Using this playbook, you can get the following list of services configured on your server. Basically, this playbook aims to get you up-and-running with all the necessities around Matrix, without you having to do anything else.
Note: the list below is exhaustive. It includes optional or even some advanced components that you will most likely not need. Sticking with the defaults (which install a subset of the above components) is the best choice, especially for a new installation. You can always re-run the playbook later to add or remove components.
Homeserver
The homeserver is the backbone of your matrix system. Choose one from the following list.
Name | Default? | Description | Documentation |
---|---|---|---|
Synapse | â | Storing your data and managing your presence in the Matrix network | Link |
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 | Link |
Dendrite | 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. | Link |
Clients
Web clients for matrix that you can host on your own domains.
Name | Default? | Description | Documentation |
---|---|---|---|
Element | â | Web UI, which is configured to connect to your own Synapse server by default | Link |
Hydrogen | x | Lightweight matrix client with legacy and mobile browser support | Link |
Cinny | x | Simple, elegant and secure web client | Link |
SchildiChat | x | Based on Element, with a more traditional instant messaging experience | Link |
Server Components
Services that run on the server to make the various parts of your installation work.
Name | Default? | Description | Documentation |
---|---|---|---|
PostgreSQL | â | Database for Synapse. Using an external PostgreSQL server is also possible. | Link |
Coturn | â | STUN/TURN server for WebRTC audio/video calls | Link |
Traefik | â | Web server, listening on ports 80, 443 and 8448 - standing in front of all the other services. Using your own webserver is possible | Link |
Let's Encrypt | â | Free SSL certificate, which secures the connection to all components | Link |
ma1sd | x | Matrix Identity Server | Link |
Exim | â | Mail server, through which all Matrix services send outgoing email (can be configured to relay through another SMTP server) | Link |
Dimension | x | An open source integrations manager for matrix clients | Link |
Sygnal | x | Push gateway | Link |
ntfy | x | Push notifications server | Link |
Authentication
Extend and modify how users are authenticated on your homeserver.
Name | Default? | Description | Documentation |
---|---|---|---|
matrix-synapse-rest-auth (advanced) | x | REST authentication password provider module | Link |
matrix-synapse-shared-secret-auth (advanced) | x | Password provider module | Link |
matrix-synapse-ldap3 (advanced) | x | LDAP Auth password provider module | Link |
matrix-ldap-registration-proxy (advanced) | x | A proxy that handles Matrix registration requests and forwards them to LDAP. | Link |
matrix-registration | x | A simple python application to have a token based matrix registration | Link |
File Storage
Use alternative file storage to the default media_store
folder.
Name | Default? | Description | Documentation |
---|---|---|---|
Goofys | x | Amazon S3 (or other S3-compatible object store) storage for Synapse's content repository (media_store ) files | Link |
synapse-s3-storage-provider | x | Amazon S3 (or other S3-compatible object store) storage for Synapse's content repository (media_store ) files | Link |
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. | Link |
Bridges
Bridges can be used to connect your matrix installation with third-party communication networks.
Bots
Bots provide various additional functionality to your installation.
Name | Default? | Description | Documentation |
---|---|---|---|
matrix-reminder-bot | x | Bot for scheduling one-off & recurring reminders and alarms | Link |
matrix-registration-bot | x | Bot for invitations by creating and managing registration tokens | Link |
maubot | x | A plugin-based Matrix bot system | Link |
honoroit | x | A helpdesk bot | Link |
Postmoogle | x | Email to matrix bot | Link |
Go-NEB | x | A multi functional bot written in Go | Link |
Mjolnir | x | A moderation tool for Matrix | Link |
Draupnir | x | A moderation tool for Matrix (Fork of Mjolnir) | Link |
Buscarron | x | Web forms (HTTP POST) to matrix | Link |
matrix-chatgpt-bot | x | ChatGPT from matrix | Link |
Administration
Services that help you in administrating and monitoring your matrix installation.
Name | Default? | Description | Documentation |
---|---|---|---|
synapse-admin | x | A web UI tool for administrating users and rooms on your Matrix server | Link |
Metrics and Graphs | x | Consists of the Prometheus time-series database server, the Prometheus node-exporter host metrics exporter, and the Grafana web UI | Link |
Borg | x | Backups | Link |
Rageshake | x | Bug report server | Link |
synapse-usage-exporter | x | Export the usage statistics of a Synapse homeserver to be scraped by Prometheus. | Link |
Misc
Various services that don't fit any other category.
Name | Default? | Description | Documentation |
---|---|---|---|
sliding-sync | x | Sliding Sync support for clients which require it (e.g. Element X) | Link |
synapse_auto_accept_invite | x | A Synapse module to automatically accept invites. | Link |
synapse_auto_compressor | x | A cli tool that automatically compresses state_groups database table in background. | Link |
synapse-simple-antispam (advanced) | x | A spam checker module | Link |
Matrix Corporal (advanced) | x | Reconciliator and gateway for a managed Matrix server | Link |
Etherpad | x | An open source collaborative text editor | Link |
Jitsi | x | An open source video-conferencing platform | Link |
Cactus Comments | x | A federated comment system built on matrix | Link |
Pantalaimon | x | An E2EE aware proxy daemon | Link |
Installation
To configure and install Matrix on your own server, follow the README in the docs/ directory.
Changes
This playbook evolves over time, sometimes with backward-incompatible changes.
When updating the playbook, refer to the changelog to catch up with what's new.
Support
-
Matrix room: #matrix-docker-ansible-deploy:devture.com
-
IRC channel:
#matrix-docker-ansible-deploy
on the Libera Chat IRC network (irc.libera.chat:6697) -
GitHub issues: spantaleev/matrix-docker-ansible-deploy/issues
Related
You may also be interested in mash-playbook - another Ansible playbook for self-hosting non-Matrix services (see its List of supported services).
mash-playbook also makes use of Traefik as its reverse-proxy, so with minor interoperability adjustments, you can make matrix-docker-ansible-deploy and mash-playbook co-exist and host Matrix and non-Matrix services on the same server.
Top Related Projects
Synapse: Matrix homeserver written in Python/Twisted.
bridge between mattermost, IRC, gitter, xmpp, slack, discord, telegram, rocketchat, twitch, ssh-chat, zulip, whatsapp, keybase, matrix, microsoft teams, nextcloud, mumble, vk and more with REST API (mattermost not required!)
A glossy Matrix collaboration client for the web.
A Matrix-WhatsApp puppeting bridge
Mattermost is an open source platform for secure collaboration across the entire software development lifecycle..
Dendrite is a second-generation Matrix homeserver written in Go!
Convert designs to code with AI
Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.
Try Visual Copilot