freshdock documentation
Everything beyond the project README. Start with the quickstart, then dive into the reference pages.
Getting started
- Quickstart — opt a container in and run the daemon in ~1 minute.
- Coming from Watchtower? — label/flag translation.
- Troubleshooting — symptom-first fixes for common first-run issues.
Reference
- Configuration — the single source of truth: labels, environment variables (the primary path), and the optional
freshdock.toml. - CLI reference —
check,recreate,run, and every flag. - Scheduling & modes — update modes and cron syntax.
- Notifications — webhook, Discord, Telegram, SMTP.
- Health gating & rollback — the recreate lifecycle and image cleanup.
- Registry authentication — private registries and credentials.
- Deployment — container, systemd, socket permissions, compatibility.
Project & process
- Architecture & roadmap — design, phases, goals, risks.
- Release runbook — how a release is cut.
- Changelog
- Contributing
- Manual test playbooks — maintainer smoke tests.
Runnable example stacks: examples/compose/.