Home

ReadyStackGo

ReadyStackGo (RSGO) is a self-hosted platform for deploying and managing Docker-based microservice stacks. One admin container, a modern web UI, manifest-based deployments – no direct Docker Compose or Kubernetes interaction needed.

Repository	GitHub
Docker Hub	wiesenwischer/readystackgo
CI/CD	GitHub Actions
License	MIT – © 2025 Marcus Dammann

---

Quick Start

curl -fsSL https://raw.githubusercontent.com/Wiesenwischer/ReadyStackGo/main/install.sh | bash

Or follow the detailed Installation Guide.

---

Key Features

Feature	Description
Single Admin Container	Manages entire stacks from one container
Web UI	Modern interface for deployment and management
Manifest-based Deployments	YAML manifests with SemVer versioning
Multi-Stack Products	Modular products with shared variables and fragments
Setup Wizard	Guided initial configuration
TLS Support	Self-signed bootstrap & custom certificates
Feature Flags	Functional switches across contexts
Role-based Security	Admin/Operator roles with JWT authentication

---

Core Concepts

Understanding these concepts is essential for working with ReadyStackGo:

Concept	Description	Learn More
Product	A deployable unit with version, services, and configuration	Products
Multi-Stack	Products composed of multiple stacks with shared variables	Multi-Stack
Fragment	Reusable, includable stack components	Stack Fragments
Variables	Configurable parameters with types and validation	Products → Variables

→ Best Practices for stack definitions

---

Documentation

Getting Started

Topic	Description
Overview	Project introduction
Quick Start	Fast-track setup
Installation	Detailed installation guide

Concepts

Topic	Description
Products	Deployable units with services and variables
Multi-Stack	Modular products with multiple stacks
Stack Fragments	Reusable stack components
Best Practices	Recommendations for stack design

Architecture

Topic	Description
Overview	System architecture
Components	Core components
Container Lifecycle	Container management
Deployment Engine	How deployments work

Configuration

Topic	Description
Overview	Configuration concepts
Config Files	rsgo.*.json files
Manifest Specification	YAML manifest format
Feature Flags	Feature toggle system
Registries	Docker registry configuration

Security

Topic	Description
Overview	Security concepts
Authentication	Login and JWT
Authorization	Roles and permissions
TLS Configuration	HTTPS setup
Initial Setup	First-time security setup

Operations

Topic	Description
Release Management	Version management
Updates	Updating RSGO and stacks
Troubleshooting	Common issues

Reference

Topic	Description
Manifest Schema	Complete YAML schema
API Reference	REST API documentation
Configuration Reference	All config options
Technical Specification	Implementation details

Development

Topic	Description
Setup Environment	Dev environment setup
Git Workflow	Branching strategy
Coding Guidelines	Code standards
Testing	Test strategy
Contributing	How to contribute

CI/CD

Topic	Description
Pipeline Integration	CI/CD setup
Workflows	GitHub Actions workflows

---

By Role

Administrator / Operator

1. Installation – Install ReadyStackGo
2. Setup Wizard – Initial configuration
3. Operations – Day-to-day management

Stack Developer

1. Products – Create deployable products
2. Multi-Stack – Build modular stacks
3. Manifest Schema – YAML reference

Platform Developer

1. Setup Environment – Development setup
2. Architecture – System design
3. Contributing – Contribution guide

---

Roadmap

See Roadmap for planned features and Plugin System for extensibility plans.

---

Help & Support

• Issues: GitHub Issues
• Contributing: Contributing Guide
• Troubleshooting: Troubleshooting