Documentation

Documentation for backupgram — automated PostgreSQL backups in Docker with rotating retention, Telegram delivery, GPG encryption, webhooks, and built-in restore tooling.

New here? Start with Getting Started.

Guides

Doc	What's in it
Getting Started	Zero-to-restorable-backup walkthrough, troubleshooting
Configuration Reference	Every environment variable, Docker secrets, retention math
CLI Commands	backup, restore, list, status, help with example output
Architecture	Runtime chain, backup cycle, rotation model, format branches, Telegram delivery (C4 + mermaid)
Large Files	MTProto upload for backups over 50 MB (up to 2 GB)
REST API	Optional HTTP control surface: endpoints, bearer auth, runtime config editing
Build	Multi-arch image builds with QEMU + buildx

Project files

File	Purpose
README.md	Project overview and quick start
CHANGELOG.md	Notable changes (Keep a Changelog)
CLAUDE.md	Contributor guide: runtime architecture, build system, testing, conventions
llms.txt	Machine-readable project map for AI agents