kevinveenbirkenbach/computer-playbook
1
0
Fork 0
mirror of https://github.com/kevinveenbirkenbach/computer-playbook.git synced 2024-11-22 12:41:05 +01:00
Code Issues Packages Projects Releases Wiki Activity
0b4e8c5c6a
computer-playbook/roles/docker-matrix-compose
History
Kevin Veen-Birkenbach 01d806fae9 Refactored for simplified use of cleanup parameter
2024-01-08 15:14:55 +01:00
..
tasks Refactored for simplified use of cleanup parameter 2024-01-08 15:14:55 +01:00
templates Renamed databasename 2024-01-06 14:32:49 +01:00
vars changed default postgres logic and optimized discourse postgres integration 2024-01-05 11:27:04 +01:00
README.md Reactivated old docker-matrix-compose role, parallel to docker-matrix-ansible to allow alternativ installation 2023-12-22 10:23:42 +01:00

README.md

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

  1. vars/main.yml: Defines variables such as docker_compose_instance_directory.
  2. handlers/main.yml: Contains handlers like recreate matrix for restarting the Matrix service.
  3. tasks/main.yml: Contains main tasks like creating directories and configuration files.
  4. templates/log.config.j2: Template for the Matrix server's logging configuration.
  5. templates/homeserver.yaml.j2: Template for the main configuration file of the Matrix server.
  6. 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

Sources

Guides

Links to ChatGPT Conversations

Alternativ Matrix Setup Role

An alternativ role to deploy Matrix you will find here.