# oddk

> Opinionated Database Deployment Kit — a self-hosted control plane that gives one Linux box the ergonomics of a managed PostgreSQL service: instances, whole-deployment snapshots, offsite copies to S3, scheduled backups, health checks and failure notifications. Single static Go binary, Docker for the containers, SQLite for local state. MIT licensed.

oddk is deliberately not highly available, not multi-tenant and not internet-facing. It runs standalone PostgreSQL instances on one trusted host. Every archive is read back in full before it counts as a copy, retention never deletes the last restore point, a failed run or an unhealthy instance sends a message, and a lost host is rebuilt from one archive plus one key. It manages Docker from the host — it is a control plane, not a workload, and is not run inside a container itself.

Install and update with the same command: `curl -fsSL https://oddk.dev/install | sh`

Every page below is also served as clean markdown at the same path plus `index.md`
(for example https://oddk.dev/docs/install/index.md), and the whole documentation set
is inlined in one file at https://oddk.dev/llms-full.txt

## Documentation
- [Install](https://oddk.dev/docs/install/): Install on a Linux host with Docker and systemd, mint a CLI token, and update in place.
- [Quickstart](https://oddk.dev/docs/quickstart/): Install oddk, create a Postgres instance, connect over SSH, and set up snapshots and alerts.
- [Snapshots & recovery](https://oddk.dev/docs/snapshots/): Whole-deployment snapshots, offsite copies, retention floors, and rebuilding a host that is gone.
- [Notifications](https://oddk.dev/docs/notifications/): Wire Slack, email, Telegram or a webhook so a failed backup is reported the moment its run ends.
- [Tuning](https://oddk.dev/docs/tuning/): Understand resource-based Postgres defaults and apply a named parameter group to an instance.

## Project
- [Source on GitHub](https://github.com/AndrianBdn/oddk): full source, issue tracker and releases
- [Releases](https://github.com/AndrianBdn/oddk/releases): binaries for linux/amd64 and linux/arm64, plus release notes
- [Install script](https://oddk.dev/install): the shell script the install command fetches