README.md

ReadyStackGo

ReadyStackGo (RSGO) ist eine selbst gehostete Plattform, um komplexe Microservice-Stacks auf Basis von Docker einfach zu installieren, zu aktualisieren und zu verwalten – mit einem einzigen Admin-Container, einer modernen Web-UI und manifestbasierten Deployments.

---

Features

• 🧩 Ein einzelner Admin-Container verwaltet den gesamten Stack
• 🧙 Geführter Setup-Wizard (Admin, Organisation, Verbindungen, Installation)
• 🔐 TLS-Handling (Self-Signed Bootstrap & später Custom-Zertifikate)
• 📦 Manifest-basierte Deployments für ganze Stacks (SemVer)
• ⚙️ Zentrale Konfiguration via rsgo.*.json
• 🏷️ Feature Flags (fachliche Schalter, kontextübergreifend)
• 🔁 CI/CD-Integration für automatische Stack-Releases
• 🔒 Security mit Admin/Operator-Rollen, JWT & später OIDC
• 🔌 Plugin-fähig (geplantes Plugin-System)

---

Repository-Struktur

/
├─ src/
│  ├─ ReadyStackGo.Api
│  ├─ ReadyStackGo.Application
│  ├─ ReadyStackGo.Domain
│  ├─ ReadyStackGo.Infrastructure
│  └─ ReadyStackGo.WebUi
├─ manifests/
├─ docs/
│  ├─ Getting-Started/
│  ├─ Architecture/
│  ├─ Configuration/
│  ├─ Setup-Wizard/
│  ├─ Security/
│  ├─ Operations/
│  ├─ Development/
│  ├─ CI-CD/
│  ├─ Reference/
│  └─ Roadmap/
├─ CONTRIBUTING.md
└─ README.md

---

Getting Started

Option 1: Docker Run

docker run -d \
  --name readystackgo \
  -p 8080:8080 \
  -v /var/run/docker.sock:/var/run/docker.sock \
  -v rsgo-config:/app/config \
  wiesenwischer/readystackgo:latest

Hinweis zum Config-Volume: Das Volume -v rsgo-config:/app/config speichert Admin-Credentials, Wizard-Status und Konfiguration persistent. Ohne dieses Volume startet ReadyStackGo bei jedem Container-Neustart frisch mit dem Setup-Wizard – praktisch zum Testen. Volume manuell löschen: docker volume rm rsgo-config

Option 2: Docker Compose

docker compose up -d

Frisch starten: Um den Wizard erneut zu durchlaufen, Volume löschen mit docker compose down -v.

Option 3: Lokale Entwicklung

Voraussetzungen:

• .NET 9.0 SDK
• Node.js 20+
• Docker (für Container-Management)

# Repository klonen
git clone https://github.com/Wiesenwischer/ReadyStackGo.git
cd ReadyStackGo

# Backend starten
cd src/ReadyStackGo.Api
dotnet run

# Frontend starten (neues Terminal)
cd src/ReadyStackGo.WebUi
npm install
npm run dev

Nach dem Start

1. Browser öffnen: http://localhost:8080 (Docker) oder http://localhost:5173 (Entwicklung)
2. Setup-Wizard durchlaufen:
   • Admin-Benutzer anlegen
   • Organisation definieren
   • Docker-Environment konfigurieren
3. Stacks deployen über die Web-UI

---

Dokumentation

Die ausführliche Dokumentation findest du im Ordner docs/:

Schnellstart

• Übersicht – Was ist ReadyStackGo?
• Quick Start – Schnellstart-Anleitung
• Installation – Detaillierte Installation

Architektur & Konzepte

• Architektur – Systemarchitektur
• Komponenten – Komponentenübersicht
• Deployment Engine – Deployment-Logik

Konfiguration

• Konfiguration – Konfigurationskonzepte
• Config-Dateien – rsgo.*.json Dateien
• Manifest-Spezifikation – Manifest-Format
• Docker Registries – Registry-Verwaltung & Image Patterns
• Feature Flags – Feature-Flag-System

Weitere Themen

• Setup-Wizard – Wizard im Detail
• Security – Sicherheitsarchitektur
• TLS – TLS-Konfiguration
• CI/CD – CI/CD-Integration
• Roadmap – Zukunftspläne

Vollständige Dokumentation

Siehe Dokumentations-Übersicht für die vollständige Übersicht.

---

Contributing

Siehe Contributing Guide.

---

Lizenz

MIT License - Copyright (c) 2025 Marcus Dammann