Home

strut

Generic, installable CLI tool for managing Docker stacks on VPS infrastructure. Deploy, monitor, and operate any number of stacks from a single command line.

Version: 0.28.0 · License: See LICENSE · Language: Bash

---

Wiki Contents

Getting Started

• Installation — Install, upgrade, and uninstall strut
• Quick Start — Initialize a project, scaffold a stack, deploy
• Interactive TUI — Interactive stack/command picker (since v0.19.0)
• Shell Completions — Tab completions for bash, zsh, and fish (since v0.17.0)

Core Concepts

• Architecture — How strut works: Strut_Home vs Project_Root, config loading, module system
• Configuration — strut.conf, services.conf, env files, per-stack config
• Multi-Host Topology — Managing multiple VPS hosts from one project (since v0.22.0)
• CLI Reference — Full command reference with examples
• Agent Steering — AI agent context: steering docs, operational skills, editor integration

Operations

• Deployment — Deploy, release, stop, update, diff, concurrency locks
• Ship and Rebuild — Commit/push/rebuild in one command; image builds on remote (since v0.22.0)
• Blue-Green Deploy — Zero-downtime deploys with health-gated proxy swap (since v0.20.0)
• Deploy Rollback — Automatic pre-deploy snapshots, one-command rollback, snapshot diff
• Remote Host Setup — Bootstrap strut on a VPS from scratch (since v0.21.0)
• Provisioning — One-time host provisioning via custom scripts (since v0.23.0)
• Database Backups — Backup, restore, pull, push for Postgres, Neo4j, MySQL, SQLite; offsite sync
• Secrets Management — Full secrets lifecycle: hydrate, validate, push, lock/unlock, rotate, export (since v0.27.0)
• Stack Groups — Coordinate deploy/backup/logs across multiple stacks
• Lifecycle Hooks — pre/post scripts for deploy, backup, health, drift events
• Notifications — Slack, Discord, and webhook event delivery
• Key Rotation — SSH keys, API keys, database passwords, GitHub secrets
• Drift Detection — Detect and fix configuration drift between git and VPS
• Domain and SSL — Custom domains, SSL certificates, nginx and Caddy support
• Certificate Management — Tailscale HTTPS cert renewal and status (since v0.24.0)
• Gateway Management — System-level Caddy reverse proxy management (since v0.24.0)
• Monitoring — Prometheus, Grafana, Alertmanager setup and alert routing
• Volume Management — Dynamic volume management from volume.conf

Advanced

• Security Posture — Cross-stack security/ops audit (strut posture)
• VPS Audit and Migration — Audit existing VPS setups, migrate to strut management
• Stack Validation — Config schema validation, secret scanning, integrity checks
• Data Anonymization — PII protection when syncing production databases locally
• Debugging — Troubleshoot production issues, view logs, status-all dashboard
• Local Development — Local stack management, env sync, database sync

Extending

• Plugins — Project-level command plugins (since v0.17.0)
• Scaffold Recipes — Custom scaffold templates (since v0.18.0)

Contributing

• Contributing — Setup, testing, linting, code conventions
• Code Conventions — Shell module standards, function naming, error handling
• Adding a New Command — Step-by-step guide for extending the CLI
• Project Structure — File layout and module responsibilities