Convert Figma logo to code with AI

spantaleev logomatrix-docker-ansible-deploy

🐳 Matrix (An open network for secure, decentralized communication) server setup using Ansible and Docker

4,812
1,039
4,812
422

Top Related Projects

11,806

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:

  1. Ensure you have a server with a supported OS (e.g., Debian 10/11, Ubuntu 20.04/22.04)
  2. Install Ansible on your local machine
  3. Clone the repository:
    git clone https://github.com/spantaleev/matrix-docker-ansible-deploy.git
    
  4. Copy inventory/host_vars/matrix.DOMAIN/vars.yml.example to inventory/host_vars/matrix.DOMAIN/vars.yml
  5. Edit vars.yml to configure your deployment
  6. 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

11,806

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 Figma logo designs to code with AI

Visual Copilot

Introducing Visual Copilot: A new AI model to turn Figma designs to high quality code using your components.

Try Visual Copilot

README

Support room on Matrix donate

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 user ID like @alice:example.com, all hosted on your own server (see prerequisites).

We run all supported 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 (see Getting started). 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.

🚀 Getting started

We have detailed documentation in the docs/ directory - see the Table of Contents in the documentation README.

While the list of supported services and documentation is very extensive, you don't need to read through everything. We recommend:

  • Starting with the basics. You can always add/remove or tweak services later on.

  • Following our installation guide. There are two guides available for beginners and advanced users:

    • ⚡ Quick start (for beginners): this is recommended for those who do not have an existing Matrix server and want to start quickly with "opinionated defaults".

    • Full installation guide (for advanced users): if you need to import an existing Matrix server's data into the new server or want to learn more while setting up the server, follow this guide by starting with the Prerequisites documentation page.

If you experience an issue on configuring the playbook, setting up your server, maintaining services on it, etc., please take a look at our FAQ. If you cannot find an answer to your question, feel free to ask for help and support.

✔ 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.

Notes:

  • 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.

  • Deprecated or unmaintained services are not listed. You can find documentations for them here.

Homeserver

The homeserver is the backbone of your Matrix system. Choose one from the following list.

NameDefault?DescriptionDocumentation
Synapse✅Storing your data and managing your presence in the Matrix networkLink
Conduit❌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 requirementsLink
Dendrite❌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.

NameDefault?DescriptionDocumentation
Element Web✅Default Matrix web client, configured to connect to your own Synapse serverLink
Hydrogen❌Lightweight Matrix client with legacy and mobile browser supportLink
Cinny❌Simple, elegant and secure web clientLink
SchildiChat Web❌Based on Element Web, with a more traditional instant messaging experienceLink

Server Components

Services that run on the server to make the various parts of your installation work.

NameDefault?DescriptionDocumentation
PostgreSQL✅Database for Synapse. Using an external PostgreSQL server is also possible.Link
Coturn✅STUN/TURN server for WebRTC audio/video callsLink
Traefik✅Web server, listening on ports 80, 443 and 8448 - standing in front of all the other services. Using your own webserver is possibleLink
Let's Encrypt✅Free SSL certificate, which secures the connection to all componentsLink
Exim✅Mail server, through which all Matrix services send outgoing email (can be configured to relay through another SMTP server)Link
ma1sd❌Matrix Identity ServerLink
ddclient❌Dynamic DNSLink

Authentication

Extend and modify how users are authenticated on your homeserver.

NameDefault?DescriptionDocumentation
matrix-synapse-rest-auth (advanced)❌REST authentication password provider moduleLink
matrix-synapse-shared-secret-auth (advanced)❌Password provider moduleLink
matrix-synapse-ldap3 (advanced)❌LDAP Auth password provider moduleLink
matrix-ldap-registration-proxy (advanced)❌A proxy that handles Matrix registration requests and forwards them to LDAP.Link
matrix-registration❌A simple python application to have a token based Matrix registrationLink
Matrix User Verification Service (UVS)❌Service to verify details of a user based on an Open ID tokenLink
synapse-simple-antispam (advanced)❌A spam checker moduleLink

File Storage

Use alternative file storage to the default media_store folder.

NameDefault?DescriptionDocumentation
Goofys❌Amazon S3 (or other S3-compatible object store) storage for Synapse's content repository (media_store) filesLink
synapse-s3-storage-provider❌Amazon S3 (or other S3-compatible object store) storage for Synapse's content repository (media_store) filesLink
matrix-media-repo❌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.

NameDefault?DescriptionDocumentation
mautrix-discord❌Bridge to DiscordLink
mautrix-slack❌Bridge to SlackLink
mautrix-telegram❌Bridge to TelegramLink
mautrix-gmessages❌Bridge to Google MessagesLink
mautrix-whatsapp❌Bridge to WhatsAppLink
mautrix-wsproxy❌Bridge to Android SMS or Apple iMessageLink
mautrix-twitter❌Bridge to TwitterLink
mautrix-googlechat❌Bridge to Google ChatLink
mautrix-meta❌Bridge to Messenger and InstagramLink for Messenger / Instagram
mautrix-signal❌Bridge to SignalLink
beeper-linkedin❌Bridge to LinkedInLink
matrix-appservice-irc❌Bridge to IRCLink
matrix-appservice-kakaotalk❌Bridge to KakaotalkLink
matrix-appservice-discord❌Bridge to DiscordLink
matrix-appservice-slack❌Bridge to SlackLink
matrix-hookshot❌Bridge for generic webhooks and multiple project management services, such as GitHub, GitLab, Figma, and Jira in particularLink
matrix-sms-bridge❌Bridge to SMSLink
matrix-wechat❌Bridge to WeChatLink
Heisenbridge❌Bouncer-style bridge to IRCLink
go-skype-bridge❌Bridge to SkypeLink
mx-puppet-slack❌Bridge to SlackLink
mx-puppet-instagram❌Bridge for Instagram-DMs (Instagram)Link
mx-puppet-twitter❌Bridge for Twitter-DMs (Twitter)Link
mx-puppet-discord❌Bridge to DiscordLink
mx-puppet-groupme❌Bridge to GroupMeLink
mx-puppet-steam❌Bridge to SteamLink
Email2Matrix❌Bridge for relaying emails to Matrix roomsLink
Postmoogle❌Email to Matrix bridgeLink

Bots

Bots provide various additional functionality to your installation.

NameDefault?DescriptionDocumentation
baibot❌A bot that exposes the power of AI / Large Language Models to youLink
matrix-reminder-bot❌Bot for scheduling one-off & recurring reminders and alarmsLink
matrix-registration-bot❌Bot for invitations by creating and managing registration tokensLink
maubot❌A plugin-based Matrix bot systemLink
Honoroit❌A helpdesk botLink
Mjolnir❌A moderation tool for MatrixLink
Draupnir❌A moderation tool for Matrix (Fork of Mjolnir)Link (for appservice mode)
Buscarron❌Web forms (HTTP POST) to MatrixLink

Administration

Services that help you in administrating and monitoring your Matrix installation.

NameDefault?DescriptionDocumentation
matrix-alertmanager-receiver❌Prometheus' Alertmanager clientLink
Matrix Authentication Service❌OAuth 2.0 and OpenID Provider serverLink
synapse-admin❌A web UI tool for administrating users and rooms on your Matrix serverLink
Metrics and Graphs❌Consists of the Prometheus time-series database server, the Prometheus node-exporter host metrics exporter, and the Grafana web UI, with prometheus-nginxlog-exporter being available tooLink (for prometheus-nginxlog-exporter)
Borg❌BackupsLink
rageshake❌Bug report serverLink
synapse-usage-exporter❌Export the usage statistics of a Synapse homeserver to be scraped by Prometheus.Link

Misc

Various services that don't fit any other categories.

NameDefault?DescriptionDocumentation
sliding-sync❌(Superseded by Simplified Sliding Sync integrated into Synapse > 1.114 and Conduit > 0.6.0) Sliding Sync support for clients which require it (e.g. old Element X versions before Simplified Sliding Sync was developed)Link
synapse_auto_accept_invite❌A Synapse module to automatically accept invites.Link
synapse_auto_compressor❌A cli tool that automatically compresses state_groups database table in background.Link
Matrix Corporal (advanced)❌Reconciliator and gateway for a managed Matrix serverLink
Etherpad❌An open source collaborative text editorLink
Jitsi❌An open source video-conferencing platformLink
Cactus Comments❌A federated comment system built on MatrixLink
Pantalaimon❌An E2EE aware proxy daemonLink
Sygnal❌Push gatewayLink
ntfy❌Push notifications serverLink

🆕 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

🤝 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.