From 3dfdc71b4d2f877d4bd564f24d27b146f8691608 Mon Sep 17 00:00:00 2001 From: Kevin Veen-Birkenbach Date: Wed, 13 Dec 2023 10:27:21 +0100 Subject: [PATCH] Implemented matrix role README.md and optimized general README.md --- README.md | 68 +++++++++++++++++++++++++++-------- roles/docker-matrix/README.md | 44 +++++++++++++++++++++++ 2 files changed, 98 insertions(+), 14 deletions(-) diff --git a/README.md b/README.md index f8e48365..de264e46 100644 --- a/README.md +++ b/README.md @@ -158,29 +158,69 @@ Focuses on web server roles and applications, covering SSL certificates, Nginx c #### Docker and Containerization Dedicated to Docker container setups and application management, offering a wide array of software deployment options. - **[Docker](./roles/docker/)**: Basic Docker and Docker Compose setup. + +##### Financial Management +Facilitating the deployment of finance-related applications. - **[Docker Akaunting](./roles/docker-akaunting/)**: Deployment of the Akaunting finance software. -- **[Docker Attendize](./roles/docker-attendize/)**: Setup for the Attendize event management tool. -- **[Docker Baserow](./roles/docker-baserow/)**: Deployment of Baserow, an open-source no-code database tool. -- **[Docker BigBlueButton](./roles/docker-bigbluebutton/)**: Setup for the BigBlueButton video conferencing tool. -- **[Docker Discourse](./roles/docker-discourse/)**: Setup of Discouse a forum and community platform. -- **[Docker ELK](./roles/docker-elk/)**: Elasticsearch, Logstash, and Kibana (ELK) stack setup. -- **[Docker Funkwhale](./roles/docker-funkwhale/)**: Deployment of Funkwhale, a federated music streaming server. + +##### Developer Tools +Setups for development platforms and version control systems. - **[Docker Gitea](./roles/docker-gitea/)**: Setup for the Gitea git server. - **[Docker Jenkins](./roles/docker-jenkins/)**: Jenkins automation server setup. +- **[Docker ELK](./roles/docker-elk/)**: Elasticsearch, Logstash, and Kibana (ELK) stack setup. + +##### Content Management +Deployment of various content management systems for web platforms. +- **[Docker Wordpress](./roles/docker-wordpress/)**: Wordpress blog and website platform setup. - **[Docker Joomla](./roles/docker-joomla/)**: Joomla content management system setup. -- **[Docker Listmonk](./roles/docker-listmonk/)**: Setup for Listmonk, a self-hosted newsletter and mailing list manager. -- **[Docker Mailu](./roles/docker-mailu/)**: Complete mail server solution. + +##### Fediverse Networks +Implementing federated and decentralized social platforms. +- **[Docker Funkwhale](./roles/docker-funkwhale/)**: Deployment of Funkwhale, a federated music streaming server. - **[Docker Mastodon](./roles/docker-mastodon/)**: Deployment of the Mastodon social network server. -- **[Docker Matomo](./roles/docker-matomo/)**: Setup for Matomo, an open-source analytics platform. -- **[Docker MediaWiki](./roles/docker-mediawiki/)**: MediaWiki setup for creating wikis. -- **[Docker MyBB](./roles/docker-mybb/)**: Setup for MyBB forum software. -- **[Docker Nextcloud](./roles/docker-nextcloud/)**: Cloud storage solution setup. - **[Docker Peertube](./roles/docker-peertube/)**: Deployment of the PeerTube video platform. - **[Docker Pixelfed](./roles/docker-pixelfed/)**: Pixelfed, a federated image sharing platform, setup. -- **[Docker Roulette Wheel](./roles/docker-roulette-wheel/)**: Setup for a custom roulette wheel application. -- **[Docker Wordpress](./roles/docker-wordpress/)**: Wordpress blog and website platform setup. + +##### Analytics Solutions +Tools for web and data analytics. +- **[Docker Matomo](./roles/docker-matomo/)**: Setup for Matomo, an open-source analytics platform. + +##### Forum Software +Deployments for community-driven forum platforms. +- **[Docker MyBB](./roles/docker-mybb/)**: Setup for MyBB forum software. +- **[Docker Discourse](./roles/docker-discourse/)**: Setup of Discouse a forum and community platform. + +##### Wiki and Documentation +Setting up platforms for collaborative information sharing. +- **[Docker MediaWiki](./roles/docker-mediawiki/)**: MediaWiki setup for creating wikis. + +##### Event and Shop Management +Tools for managing events and online retail. +- **[Docker Attendize](./roles/docker-attendize/)**: Setup for the Attendize event management tool. + +##### Data and Cloud Storage +Solutions for data management and cloud-based storage. +- **[Docker Baserow](./roles/docker-baserow/)**: Deployment of Baserow, an open-source no-code database tool. +- **[Docker Nextcloud](./roles/docker-nextcloud/)**: Cloud storage solution setup. + +##### Communication and Collaboration +Platforms for enhancing communication and collaborative efforts. +- **[Docker BigBlueButton](./roles/docker-bigbluebutton/)**: Setup for the BigBlueButton video conferencing tool. +- **[Docker Mailu](./roles/docker-mailu/)**: Complete mail server solution. +- **[Docker Matrix](./roles/docker-matrix/)**: Setup and deployment of the Matrix server for secure, decentralized communication. + +##### Marketing and Communication Tools +Focusing on tools that assist in communication, marketing, and outreach efforts. +- **[Docker Listmonk](./roles/docker-listmonk/)**: Setup for Listmonk, a self-hosted newsletter and mailing list manager. + +##### Web Utilities and Services +Encompassing tools that enhance web functionality or provide essential web services. - **[Docker YOURLS](./roles/docker-yourls/)**: Setup for YOURLS, a URL shortening service. +##### Miscellaneous +Diverse tools for specific needs and utilities. +- **[Docker Roulette Wheel](./roles/docker-roulette-wheel/)**: Setup for a custom roulette wheel application. + ### Other Encompasses miscellaneous essential tools and systems, including AUR helper, spellchecking, typesetting, and package management. - **[System-Aur-Helper](./roles/system-aur-helper/)**: Installs and configures AUR helper (yay). diff --git a/roles/docker-matrix/README.md b/roles/docker-matrix/README.md index e69de29b..3788a6ab 100644 --- a/roles/docker-matrix/README.md +++ b/roles/docker-matrix/README.md @@ -0,0 +1,44 @@ +# 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 + +- https://chat.openai.com/share/d4485223-3750-4b0b-9733-45776c55d7cf +- https://chat.openai.com/share/f68873d9-aae9-4a1e-83b6-c3f23705a4ad +- https://chat.openai.com/share/11690964-9997-4e44-b63f-3c384a5ddc1d +- https://chat.openai.com/share/6f537c30-7337-47ed-8c85-19306e0eb74b +- https://chat.openai.com/share/31974492-2950-4dbc-8a83-edd7e1569bec \ No newline at end of file