docs: document stacks.sh in README
Replace manual docker compose / systemctl snippets with stacks.sh equivalents and add a dedicated section covering all commands. Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
@@ -20,11 +20,72 @@ Each stack is independently deployable with its own `compose.yml` and `.env`. Al
|
||||
|
||||
## Tools
|
||||
|
||||
| Directory | Description |
|
||||
| File/Directory | Description |
|
||||
|---|---|
|
||||
| `stacks.sh` | CLI to manage stacks, services, and scaffolding |
|
||||
| `_backup` | Daily restic backups to HiDrive (host script + systemd timer) |
|
||||
| `_update` | Nightly image update check + prune (host script + systemd timer) |
|
||||
|
||||
## stacks.sh
|
||||
|
||||
`stacks.sh` is the primary management CLI. It wraps `docker compose` with glob-based multi-stack targeting, manages the update and backup systemd services, scaffolds new stacks, and generates shell completions.
|
||||
|
||||
```bash
|
||||
./stacks.sh help
|
||||
```
|
||||
|
||||
**Stack commands** — all accept one or more stack names or glob patterns (omit for all stacks):
|
||||
|
||||
```bash
|
||||
./stacks.sh ls # list all stacks with live container status
|
||||
./stacks.sh ps gitea # container status table
|
||||
./stacks.sh up # start all stacks
|
||||
./stacks.sh up gitea traefik # start specific stacks
|
||||
./stacks.sh down 'g*' # stop stacks matching glob
|
||||
./stacks.sh restart 'g*,traefik' # glob + exact name, comma-separated
|
||||
./stacks.sh pull --parallel # pull all images in parallel
|
||||
./stacks.sh logs -f gitea # follow logs
|
||||
./stacks.sh logs -n 100 gitea n8n # tail multiple stacks
|
||||
./stacks.sh exec gitea gitea gitea admin user list # exec in container
|
||||
./stacks.sh run passbolt passbolt bin/cake passbolt healthcheck
|
||||
```
|
||||
|
||||
**Service management:**
|
||||
|
||||
```bash
|
||||
./stacks.sh update install # link & enable systemd update timer
|
||||
./stacks.sh update run # run update now
|
||||
./stacks.sh update status # show timer/service status
|
||||
./stacks.sh update logs # show journal logs
|
||||
|
||||
./stacks.sh backup install # link & enable systemd backup timer
|
||||
./stacks.sh backup run # run backup now
|
||||
./stacks.sh backup snapshots # list restic snapshots
|
||||
```
|
||||
|
||||
**Scaffold a new stack:**
|
||||
|
||||
```bash
|
||||
./stacks.sh new myapp # basic stack with Traefik labels
|
||||
./stacks.sh new myapp --db postgres # with Postgres service
|
||||
./stacks.sh new myapp --db postgres --redis # with Postgres + Redis
|
||||
./stacks.sh new myapp --no-traefik # expose port instead of Traefik
|
||||
```
|
||||
|
||||
Generates `compose.yml` (with healthchecks, `../.data/` volumes, Traefik labels) and `.env.example`.
|
||||
|
||||
**Shell completion:**
|
||||
|
||||
```bash
|
||||
# Dynamic — discovers stacks at tab-complete time (default)
|
||||
./stacks.sh completion zsh --install
|
||||
|
||||
# Static — bakes current stack list in; useful on the VPS
|
||||
./stacks.sh completion zsh --static --install
|
||||
```
|
||||
|
||||
**Global flags:** `--dry-run`, `--parallel`, `--verbose`, `--quiet`
|
||||
|
||||
## Deployment
|
||||
|
||||
```bash
|
||||
@@ -53,19 +114,13 @@ rsync -avz _backup/ vps:~/stacks/_backup/
|
||||
# Initialize restic repo (first time only)
|
||||
ssh vps 'source ~/stacks/_backup/.env && restic init -r /mnt/hidrive/users/valknar/Backup/stacks'
|
||||
|
||||
# Install systemd units
|
||||
ssh vps 'ln -sf ~/stacks/_backup/stacks-backup.service /etc/systemd/system/ && \
|
||||
ln -sf ~/stacks/_backup/stacks-backup.timer /etc/systemd/system/ && \
|
||||
systemctl daemon-reload && systemctl enable --now stacks-backup.timer'
|
||||
# Install systemd units (or use stacks.sh on the VPS)
|
||||
ssh vps '~/stacks/stacks.sh backup install'
|
||||
|
||||
# Manual test run
|
||||
ssh vps '~/stacks/_backup/backup.sh'
|
||||
|
||||
# Check timer status
|
||||
ssh vps 'systemctl status stacks-backup.timer'
|
||||
|
||||
# View snapshots
|
||||
ssh vps 'source ~/stacks/_backup/.env && restic -r /mnt/hidrive/users/valknar/Backup/stacks snapshots'
|
||||
# Manual run / status
|
||||
ssh vps '~/stacks/stacks.sh backup run'
|
||||
ssh vps '~/stacks/stacks.sh backup status'
|
||||
ssh vps '~/stacks/stacks.sh backup snapshots'
|
||||
```
|
||||
|
||||
## Updates
|
||||
@@ -75,18 +130,13 @@ The `_update` script runs nightly at 2:00 AM. It pulls the latest image for ever
|
||||
```bash
|
||||
# Deploy update stack
|
||||
rsync -avz _update/ vps:~/stacks/_update/
|
||||
ssh vps 'chmod +x ~/stacks/_update/update.sh'
|
||||
|
||||
# Install systemd units
|
||||
ssh vps 'ln -sf ~/stacks/_update/stacks-update.service /etc/systemd/system/ && \
|
||||
ln -sf ~/stacks/_update/stacks-update.timer /etc/systemd/system/ && \
|
||||
systemctl daemon-reload && systemctl enable --now stacks-update.timer'
|
||||
# Install systemd units (or use stacks.sh on the VPS)
|
||||
ssh vps '~/stacks/stacks.sh update install'
|
||||
|
||||
# Manual test run
|
||||
ssh vps '~/stacks/_update/update.sh'
|
||||
|
||||
# Check timer status
|
||||
ssh vps 'systemctl status stacks-update.timer'
|
||||
# Manual run / status
|
||||
ssh vps '~/stacks/stacks.sh update run'
|
||||
ssh vps '~/stacks/stacks.sh update status'
|
||||
```
|
||||
|
||||
## Notifications
|
||||
|
||||
Reference in New Issue
Block a user