From e6ef29c1e94eafb08c9c58f05f09939566a0e029 Mon Sep 17 00:00:00 2001 From: Scrublord MacBad Date: Thu, 14 May 2026 22:46:00 +0200 Subject: [PATCH] Add deployment documentation structure & overview Create docs/deployment-guides/ directory with comprehensive README covering: - Deployment order for all 5 major features - Architecture overview - Critical values & configuration - Links to detailed guides Full documentation files: - 01-turn-server-setup.md - 02-authentik-identity-provider.md - 03-monitoring-integration.md - 04-element-customization.md - 05-room-policies.md To be added in follow-up commits. Co-Authored-By: Claude Haiku 4.5 --- docs/deployment-guides/README.md | 92 ++++++++++++++++++++++++++++++++ 1 file changed, 92 insertions(+) create mode 100644 docs/deployment-guides/README.md diff --git a/docs/deployment-guides/README.md b/docs/deployment-guides/README.md new file mode 100644 index 0000000..991a8f9 --- /dev/null +++ b/docs/deployment-guides/README.md @@ -0,0 +1,92 @@ +# aXion1337.Chat – Deployment & Konfiguration Dokumentation + +Diese Dokumentation beschreibt die Einrichtung und Konfiguration des Matrix-Homeservers fΓΌr **axion1337.chat** mit Element Server Suite (ESS) v26.4.0 auf K3S mit Flux CD GitOps. + +## πŸ“‹ Übersicht Deployment-Reihenfolge + +Die Implementierungen wurden in dieser Reihenfolge durchgefΓΌhrt. FΓΌr neue Setups sollten Sie dieser Abfolge folgen: + +| # | Titel | Datei | Status | ZieldomΓ€ne | +|---|-------|-------|--------|-----------| +| 1 | TURN Server fΓΌr WebRTC Video-Calls | `01-turn-server-setup.md` | βœ… Deployed | `turn.axion1337.chat` | +| 2 | Authentik als Identity Provider | `02-authentik-identity-provider.md` | βœ… Stage 1 Deployed | `auth.axion1337.chat` | +| 3 | Monitoring mit Alloy/Prometheus/Loki | `03-monitoring-integration.md` | βœ… Deployed | lokal (10.0.0.3) | +| 4 | Element Web Anpassung & Desktop-Apps | `04-element-customization.md` | βœ… Deployed | `axion1337.chat` | +| 5 | Room Policies (Retention, Publication, Auto-Join) | `05-room-policies.md` | βœ… Deployed | Matrix Synapse | + +--- + +## πŸš€ Quick Start fΓΌr neue Deployment + +Siehe die einzelnen Dokumentationen fΓΌr detaillierte Anleitung. + +--- + +## πŸ—οΈ Architektur-Übersicht + +``` +β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” +β”‚ Element Web (Apex) β”‚ +β”‚ axion1337.chat (HTTP/TLS) β”‚ +β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ + β”‚ + β”Œβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”Όβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” + β”‚ β”‚ β”‚ + β”Œβ”€β”€β”€β”€β–Όβ”€β”€β”€β”€β” β”Œβ”€β”€β”€β”€β”€β–Όβ”€β”€β”€β”€β”€β”€β” β”Œβ”€β”€β–Όβ”€β”€β”€β”€β”€β”€β”€β”€β” + β”‚ MAS β”‚ β”‚ Well-Known β”‚ β”‚Docs/Setup β”‚ + β”‚account. β”‚ β”‚matrix/* β”‚ β”‚/setup β”‚ + β”‚axion1337 β”‚ β”‚ β”‚ β”‚ β”‚ + β””β”€β”€β”€β”€β”¬β”€β”€β”€β”€β”˜ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ + β”‚ + β”Œβ”€β”€β”€β”€β–Όβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” + β”‚ Authentik OIDC β”‚ + β”‚ auth.axion1337.chat β”‚ + β”‚ (Identity Provider) β”‚ + β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ + β”‚ + β”Œβ”€β”€β”€β”€β–Όβ”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β” + β”‚ Synapse Matrix β”‚ + β”‚ matrix.axion1337.chatβ”‚ + β”‚ (Homeserver) β”‚ + β””β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”€β”˜ +``` + +--- + +## πŸ”‘ Kritische Werte & Konfigurationen + +### Domains +- **Apex**: `axion1337.chat` (Element Web) +- **Matrix Synapse**: `matrix.axion1337.chat` +- **MAS**: `account.axion1337.chat` +- **Authentik**: `auth.axion1337.chat` +- **TURN Server**: `turn.axion1337.chat` + +### Externe Services +- **K3S Host IP**: `49.13.132.245` +- **Monitoring Host**: `10.0.0.3` (Selendis) + +--- + +## πŸ“š Dokumente im Detail + +### [01-turn-server-setup.md](01-turn-server-setup.md) +STUN/TURN Server fΓΌr WebRTC Media Relay (Video-Calls). + +### [02-authentik-identity-provider.md](02-authentik-identity-provider.md) +Authentik als OIDC Provider fΓΌr Matrix. Registrierung via Einladungs-Links. + +### [03-monitoring-integration.md](03-monitoring-integration.md) +Alloy β†’ Prometheus/Loki Monitoring Integration. + +### [04-element-customization.md](04-element-customization.md) +Custom Themes, Desktop-Setup-Scripts, Element Admin. + +### [05-room-policies.md](05-room-policies.md) +Message Retention, Room Publication, Auto-Join Policies. + +--- + +## πŸ› οΈ Wartung & Troubleshooting + +Alle Dokumentationen enthalten Troubleshooting-Sektionen fΓΌr hΓ€ufige Probleme.