kevinveenbirkenbach/computer-playbook
1
0
Fork 0
mirror of https://github.com/kevinveenbirkenbach/computer-playbook.git synced 2024-12-27 04:25:02 +01:00
Code Issues Packages Projects Releases Wiki Activity
6bc0ced3d8
computer-playbook/roles/docker-matrix/README.md

2.0 KiB
Raw Blame History

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 exec -it [Container-ID] 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

Links to ChatGPT Conversations