Michael Schiemer
de8fed8711
- Add pre-flight checks in deploy-update.yml - Automatically copy docker-compose.yml and nginx config in setup-infrastructure.yml - Add comprehensive deployment documentation - Ready for automated code deployments via CI/CD pipeline
170 lines
4.7 KiB
Markdown
170 lines
4.7 KiB
Markdown
# Deployment Dokumentation - Index
|
|
|
|
**Stand:** 2025-10-31
|
|
**Status:** ✅ Vollständige Dokumentation vorhanden
|
|
|
|
---
|
|
|
|
## 🚀 Schnellstart
|
|
|
|
### Für schnellen Einstieg
|
|
|
|
1. **[QUICK_START.md](QUICK_START.md)** ⭐
|
|
- Schnellstart-Guide
|
|
- Pipeline-Status prüfen
|
|
- Troubleshooting Quick Reference
|
|
|
|
2. **[CODE_CHANGE_WORKFLOW.md](CODE_CHANGE_WORKFLOW.md)**
|
|
- Wie Codeänderungen gepusht werden
|
|
- Automatisches vs. manuelles Deployment
|
|
- Branching-Strategien
|
|
- Beispiel-Workflows
|
|
|
|
---
|
|
|
|
## 📚 Detaillierte Guides
|
|
|
|
### Deployment-Prozess
|
|
|
|
3. **[APPLICATION_STACK_DEPLOYMENT.md](APPLICATION_STACK_DEPLOYMENT.md)**
|
|
- Detaillierter Deployment-Ablauf Schritt für Schritt
|
|
- Was passiert bei jedem Deployment
|
|
- Container-Neustart Details
|
|
- Rollback-Prozess
|
|
- Troubleshooting
|
|
|
|
### CI/CD Pipeline
|
|
|
|
4. **[CI_CD_STATUS.md](CI_CD_STATUS.md)**
|
|
- Aktueller CI/CD Status
|
|
- Secrets-Übersicht
|
|
- Runner-Status
|
|
- Checkliste für Completion
|
|
- Troubleshooting
|
|
|
|
### Setup & Konfiguration
|
|
|
|
5. **[SETUP-GUIDE.md](SETUP-GUIDE.md)**
|
|
- Kompletter Setup-Guide von Anfang bis Ende
|
|
- Infrastructure Deployment
|
|
- Gitea Runner Setup
|
|
- Secrets Konfiguration
|
|
- Schritt-für-Schritt Anleitung
|
|
|
|
---
|
|
|
|
## 📊 Status & Übersicht
|
|
|
|
### Projekt-Status
|
|
|
|
6. **[DEPLOYMENT_SUMMARY.md](DEPLOYMENT_SUMMARY.md)**
|
|
- Was ist fertig?
|
|
- Was fehlt noch?
|
|
- Completion Rate
|
|
- Nächste Schritte
|
|
|
|
7. **[DEPLOYMENT-TODO.md](DEPLOYMENT_TODO.md)**
|
|
- Aktuelle TODO-Liste
|
|
- Priorisierte Reihenfolge
|
|
- Quick Checklist
|
|
|
|
8. **[DEPLOYMENT-STATUS.md](DEPLOYMENT-STATUS.md)**
|
|
- Detaillierter Status aller Phasen
|
|
- Phasen-basierte Übersicht
|
|
- Historischer Status
|
|
|
|
---
|
|
|
|
## 🔧 Stack-spezifische Dokumentation
|
|
|
|
### Infrastructure Stacks
|
|
|
|
- **[stacks/traefik/README.md](stacks/traefik/README.md)** - Reverse Proxy & SSL
|
|
- **[stacks/postgresql/README.md](stacks/postgresql/README.md)** - Database mit Backups
|
|
- **[stacks/registry/README.md](stacks/registry/README.md)** - Private Docker Registry
|
|
- **[stacks/gitea/README.md](stacks/gitea/README.md)** - Git Server & CI/CD
|
|
- **[stacks/monitoring/README.md](stacks/monitoring/README.md)** - Monitoring Tools
|
|
|
|
### Application Stack
|
|
|
|
- **[stacks/application/README.md](stacks/application/README.md)** - Application Stack Details
|
|
- **[ansible/README.md](ansible/README.md)** - Ansible Playbooks Dokumentation
|
|
|
|
### CI/CD
|
|
|
|
- **[gitea-runner/README.md](gitea-runner/README.md)** - Gitea Runner Setup
|
|
- **[.gitea/workflows/production-deploy.yml](../.gitea/workflows/production-deploy.yml)** - Haupt-Deployment-Pipeline
|
|
|
|
---
|
|
|
|
## 🔐 Security & VPN
|
|
|
|
- **[docs/WIREGUARD-SETUP.md](docs/WIREGUARD-SETUP.md)** - WireGuard VPN Setup
|
|
- **[ansible/playbooks/README-WIREGUARD.md](ansible/playbooks/README-WIREGUARD.md)** - WireGuard Ansible Playbooks
|
|
|
|
---
|
|
|
|
## 🆘 Troubleshooting
|
|
|
|
### Workflow-Probleme
|
|
|
|
- **[WORKFLOW-TROUBLESHOOTING.md](WORKFLOW-TROUBLESHOOTING.md)** - Workflow Troubleshooting
|
|
- **[NATIVE-WORKFLOW-README.md](NATIVE-WORKFLOW-README.md)** - Native Workflow ohne GitHub Actions
|
|
|
|
### Allgemeine Hilfe
|
|
|
|
- **[QUICK_START.md](QUICK_START.md)** - Troubleshooting Quick Reference
|
|
- **[CI_CD_STATUS.md](CI_CD_STATUS.md)** - CI/CD Troubleshooting
|
|
- **[APPLICATION_STACK_DEPLOYMENT.md](APPLICATION_STACK_DEPLOYMENT.md)** - Deployment Troubleshooting
|
|
|
|
---
|
|
|
|
## 📖 Haupt-Dokumentation
|
|
|
|
- **[README.md](README.md)** - Haupt-Dokumentation & Übersicht
|
|
- **[SETUP-GUIDE.md](SETUP-GUIDE.md)** - Kompletter Setup-Guide
|
|
|
|
---
|
|
|
|
## 🎯 Empfohlene Lesereihenfolge
|
|
|
|
### Für neue Nutzer
|
|
|
|
1. **[QUICK_START.md](QUICK_START.md)** - Schneller Überblick
|
|
2. **[CODE_CHANGE_WORKFLOW.md](CODE_CHANGE_WORKFLOW.md)** - Code deployen lernen
|
|
3. **[DEPLOYMENT_SUMMARY.md](DEPLOYMENT_SUMMARY.md)** - Projekt-Status verstehen
|
|
|
|
### Für Deployment-Verständnis
|
|
|
|
1. **[APPLICATION_STACK_DEPLOYMENT.md](APPLICATION_STACK_DEPLOYMENT.md)** - Wie Deployment funktioniert
|
|
2. **[CI_CD_STATUS.md](CI_CD_STATUS.md)** - CI/CD Pipeline verstehen
|
|
3. **[SETUP-GUIDE.md](SETUP-GUIDE.md)** - Komplette Setup-Anleitung
|
|
|
|
### Für Troubleshooting
|
|
|
|
1. **[QUICK_START.md](QUICK_START.md)** - Quick Troubleshooting
|
|
2. **[WORKFLOW-TROUBLESHOOTING.md](WORKFLOW-TROUBLESHOOTING.md)** - Workflow-Probleme
|
|
3. Stack-spezifische READMEs für Details
|
|
|
|
---
|
|
|
|
## 📝 Dokumentations-Standards
|
|
|
|
**Alle Dokumentationsdateien:**
|
|
- Verwenden Markdown-Format
|
|
- Haben klare Überschriften-Struktur
|
|
- Enthalten Code-Beispiele
|
|
- Haben Troubleshooting-Abschnitte (wenn relevant)
|
|
- Verlinken zu verwandten Dokumenten
|
|
|
|
**Standards:**
|
|
- ✅ Beispiele sind ausführbar
|
|
- ✅ Pfade sind absolut oder relativ klar
|
|
- ✅ Screenshots/Links sind aktuell
|
|
- ✅ Status ist klar markiert (✅/⚠️/❌)
|
|
|
|
---
|
|
|
|
**Letzte Aktualisierung:** 2025-10-31
|
|
**Status:** ✅ Dokumentation vollständig
|