Docker Housekeeper

Features:

• Database initialization
  • Create Database
  • Create User
  • add PG extensions
• Scheduled backup of database and data directories
• Encrypted backups via age
• Backup upload via rclone

Usage

Only database initialization:

services:
  db_init:
    image: ghcr.io/bboehmke/docker-housekeeper
    environment:
      DB_HOST: host_name
      DB_ROOT_PASSWORD: password
      DB_DATABASE: database_to_create
      DB_USER_NAME: user_to_create
      DB_USER_PASSWORD: user_password

Backup 2 directories:

services:
  db_init:
    image: ghcr.io/bboehmke/docker-housekeeper
    volumes:
      - ./data/A/:/data/A/
      - ./data/B/:/data/B/
      - ./backup/:/backup/
    environment:
      BACKUP_DATA_DIR: "/data/A,/data/B"

Initialize database and scheduled backup (including directories):

services:
  db_init:
    image: ghcr.io/bboehmke/docker-housekeeper
    volumes:
      - ./data/A/:/data/A/
      - ./data/B/:/data/B/
      - ./backup/:/backup/
    environment:
      DB_HOST: host_name
      DB_ROOT_PASSWORD: password
      DB_DATABASE: database_to_create
      DB_USER_NAME: user_to_create
      DB_USER_PASSWORD: user_password

      BACKUP_DATABASE: "true"
      BACKUP_DATA_DIR: "/data/A,/data/B"

Encrypt the backup with an age:

services:
  db_init:
    image: ghcr.io/bboehmke/docker-housekeeper
    volumes:
      - ./data/A/:/data/A/
      - ./backup/:/backup/
    environment:
      BACKUP_DATA_DIR: "/data/A"
      BACKUP_AGE_RECIPIENTS: "age1zdrn7wzxwt3lce5sw4hlx0...sth2ykx"

The public and private keys the encryption can be created with age-keygen. See age documentation for more details.

Available Configuration Parameters

The configuration is done via environment variables.

Database

• DB_HOST: Hostname of database server
• DB_PORT: Port of database server (Default: 5432)
• DB_ROOT_PASSWORD: Password of root account
• DB_ROOT_USER: Name of root account (Default: postgres)
• DB_DATABASE: Database to create
• DB_USER_NAME: User to create with access to DB_DATABASE
• DB_USER_PASSWORD: Password of DB_USER_NAME
• DB_PG_EXTENSIONS: List of postgres extensions

Backup

• BACKUP_AGE_PASSWORD: Password to encrypt the backup
• BACKUP_AGE_RECIPIENTS: List of recipient keys used to encrypt the backup (Separated by ",")
• BACKUP_DATABASE: True if database should be part of backup
• BACKUP_DATA_DIR: List of directories to back up (Separated by ",")
• BACKUP_DATA_EXCLUDE: List of directories to exclude from backup (Separated by ",")
• BACKUP_RCLONE_PATH: Path of rclone remote storage location
• BACKUP_RCLONE_CONFIG: Path of rclone config file
• BACKUP_SCHEDULE: Cron expression (Default: @daily)
• BACKUP_STORAGE: Storage location for backups