Postgres backup

Postgres backup is a backup script for PostgreSQL databases. It dumps a database, compresses it and stores backups in a S3 bucket on your preferred cloud provider. This project is designed to run in a Docker container, making deployment and management straightforward.

Configuration

This script requires several environment variables to work properly:

Variable	Description	Required	Example
TZ	Personalize timezone	no	Europe/Paris
---	---	---	---
DB_HOST	The host of the database	yes	postgres
DB_PORT	The port of the database	yes	5432
DB_USER	The user of the database	yes	postgres
DB_PASSWORD	The password of the database	yes	postgres
DB_NAME	The name of the database	yes	plannify
---	---	---
BACKUP_DIR	The directory of the backup	no	'daily', 'weekly', 'monthly'
BACKUP_MAX_BEFORE_DELETE	The maximum number of backup before deleting the oldest one	no	7
BACKUP_COMPRESSION	The compression method to use for the backup file (no compression by default)	no	zip, gzip, xz
BACKUP_AGE_RECIPIENT	The public key of the recipient to encrypt the backup file (no encryption by default)	no	age15...
---	---	---
S3_ENDPOINT	The bucket endpoint	yes	https://...
S3_ACCESS_TOKEN	The access token of your provider account	yes	1234567890
S3_SECRET_ACCESS_TOKEN	The secret access token of your provider account	yes	1234567890
S3_BUCKET	The S3 bucket of your account	yes	plannify
---	---	---
STATUS_ENDPOINT	The endpoint to send backup status	no	https://my-uptime-kuma.com/backup-status

Usage

This script is designed to be run in a Docker container. You can use it in a kubernetes CronJob or in a Docker container directly.

Examples

This section provides config examples of how to use the script with different cloud providers.

Cloudflare R2

S3_ENDPOINT: https://<account_id>.r2.cloudflarestorage.com
S3_ACCESS_TOKEN: 1234567890
S3_SECRET_ACCESS_TOKEN: 1234567890
S3_BUCKET: plannify

AWS S3

S3_ENDPOINT: https://s3.amazonaws.com
S3_ACCESS_TOKEN: 1234567890
S3_SECRET_ACCESS_TOKEN: 1234567890
S3_BUCKET: plannify

GCP Cloud Storage

S3_ENDPOINT: https://storage.googleapis.com
S3_ACCESS_TOKEN: 1234567890
S3_SECRET_ACCESS_TOKEN: 1234567890
S3_BUCKET: plannify

Azure Blob Storage

S3_ENDPOINT: https://<account_name>.blob.core.windows.net
S3_ACCESS_TOKEN: 1234567890
S3_SECRET_ACCESS_TOKEN: 1234567890
S3_BUCKET: plannify

Test

Before running the script and if you want to test the encryption process, you can generate a key pair using the age tool:

age-keygen -o key.txt

You can test the script by running it in a Docker container with the required environment variables. Make sure to replace the example values with your actual configuration.

docker compose up -d --build

You can view the logs to see the backup process:

docker compose logs backup -f