Skip to content

docs: fix config-format bugs found during real deployment#27

Merged
mitchelljphayes merged 1 commit into
mainfrom
fix-docs-config-format
Jun 25, 2026
Merged

docs: fix config-format bugs found during real deployment#27
mitchelljphayes merged 1 commit into
mainfrom
fix-docs-config-format

Conversation

@mitchelljphayes

Copy link
Copy Markdown
Owner

Fixes the config-format errors discovered while deploying a real app (Quack catalog server) on a clean VPS — every one of these would trip up a new user following the docs:

  • App config is a single [app] table, not [[apps]] (this was wrong in the README rewrite)
  • [auth] and [registry] are required sections in slip.toml
  • [health] is a required section in the app config (omit path to skip the HTTP probe)
  • Volumes are [[volumes]], routes are [[routing.routes]] (not [[apps.volumes]]/[[apps.routes]])
  • CLI is slip secrets (plural); set syntax is slip secrets set <app> KEY=VALUE --token <global-secret>
  • Added troubleshooting entries for the missing-field and wrong-subcommand errors

All verified against a working deployment.

Found while deploying a real app on a clean VPS:
- App config uses [app] (single table), not [[apps]]
- [auth] and [registry] are required sections in slip.toml
- [health] is a required section in app config (omit path to skip HTTP probe)
- Volumes are [[volumes]], routes are [[routing.routes]] (not [[apps.*]])
- CLI is 'slip secrets' (plural); set is 'slip secrets set <app> KEY=VALUE --token <global>'
- Added troubleshooting entries for the missing-field and subcommand errors
@mitchelljphayes mitchelljphayes merged commit 5ec8663 into main Jun 25, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant