mirror of
https://github.com/kevinveenbirkenbach/computer-playbook.git
synced 2025-08-29 15:06:26 +02:00
Optimized .mds and meta/main.yml for client-wireguard roles and refactored README.md of Docker Roles
This commit is contained in:
9
roles/docker-matrix-compose/Administration.md
Normal file
9
roles/docker-matrix-compose/Administration.md
Normal file
@@ -0,0 +1,9 @@
|
||||
# Administration
|
||||
|
||||
## 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
|
||||
```
|
21
roles/docker-matrix-compose/Installation.md
Normal file
21
roles/docker-matrix-compose/Installation.md
Normal file
@@ -0,0 +1,21 @@
|
||||
# Installation
|
||||
|
||||
## Bridges
|
||||
|
||||
### Mautrix
|
||||
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](https://docs.mau.fi/bridges/go/slack/authentication.html).
|
||||
|
||||
### ChatGPT
|
||||
- Create API Token: https://platform.openai.com/api-keys
|
||||
- Set ``matrix_chatgpt_bridge_access_token``
|
||||
|
||||
## Debug:
|
||||
- https://federationtester.matrix.org/
|
@@ -1,40 +1,12 @@
|
||||
# Docker-Matrix Role README
|
||||
|
||||
## Overview
|
||||
## 📌 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. This role was developed by [Kevin Veen-Birkenbach](https://www.veen.world/)
|
||||
|
||||
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.
|
||||
|
||||
## 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
|
||||
|
||||
### Mautrix
|
||||
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](https://docs.mau.fi/bridges/go/slack/authentication.html).
|
||||
|
||||
### ChatGPT
|
||||
- Create API Token: https://platform.openai.com/api-keys
|
||||
- Set ``matrix_chatgpt_bridge_access_token``
|
||||
|
||||
## Debug:
|
||||
- https://federationtester.matrix.org/
|
||||
|
||||
## Sources
|
||||
## Credits 📝
|
||||
|
||||
### Guides
|
||||
- https://matrix-org.github.io/synapse/latest/usage/configuration/config_documentation.html
|
||||
|
Reference in New Issue
Block a user