Docker-Matrix Role README

Overview

This document serves as the README for the docker-matrix role, a part of the CyMaIS project. This role automates the deployment of a Matrix server using Docker.

Matrix is an open-source project that provides a protocol for secure, decentralized, real-time communication. It offers features like end-to-end encrypted chat, VoIP, and file sharing, catering to both individual and enterprise users. With a focus on interoperability, Matrix can bridge with other communication systems, offering a unified platform for messaging and collaboration.

Dependencies

nginx-docker-reverse-proxy (see meta/main.yml)

Files and Their Functions

vars/main.yml: Defines variables such as docker_compose_instance_directory.
handlers/main.yml: Contains handlers like recreate matrix for restarting the Matrix service.
tasks/main.yml: Contains main tasks like creating directories and configuration files.
templates/log.config.j2: Template for the Matrix server's logging configuration.
templates/homeserver.yaml.j2: Template for the main configuration file of the Matrix server.
templates/docker-compose.yml.j2: Docker-Compose template for setting up the Matrix server and database.

Important Administration Commands

Create Matrix Users:

docker compose exec -it synapse register_new_matrix_user -u [Username] -p [Password] -a -c /data/homeserver.yaml http://localhost:8008

Execute Docker-Compose Commands:

Restart services:
```
docker-compose up -d --force-recreate
```
View logs:
```
docker-compose logs
```

Cleanup

# Cleanup Database
for db in matrix mautrix_whatsapp_bridge mautrix_telegram_bridge mautrix_signal_bridge mautrix_slack_bridge; do python reset-database-in-central-postgres.py $db; done
# Cleanup Docker and Volumes
docker compose down -v

Bridges

General

Contact one of the following bots for more information:

@signalbot:yourdomain.tld
@telegrambot:yourdomain.tld
@whatsappbot:yourdomain.tld
@slackbot:yourdomain.tld

Slack

For login with Token checkout this guide.

Debug:

https://federationtester.matrix.org/

Sources

Guides

Links to ChatGPT Conversations

Alternativ Matrix Setup Role

An alternativ role to deploy Matrix you will find here.

3.0 KiB Raw Blame History