Borgmatic Backup System

Key Features

• Automated backup scheduling with configurable retention policies and pruning rules
• BorgBackup deduplication engine reducing storage requirements by 80-95% for typical datasets
• Built-in health checks with configurable monitoring hooks for external alerting systems
• Support for multiple repository types including local, SSH, S3, and other cloud providers
• Automatic repository maintenance including compact operations and consistency checks
• Comprehensive logging and error reporting with customizable notification channels
• YAML-based configuration supporting multiple backup jobs and complex filtering rules
• Integration with monitoring systems through healthchecks.io, Prometheus, and webhook notifications

Common Use Cases

• 1Automated server backup workflows for production infrastructure with compliance requirements
• 2Development team data protection for source code repositories and build artifacts
• 3Database backup automation with point-in-time recovery capabilities
• 4Homelab and personal server backup management with minimal maintenance overhead
• 5Multi-tenant backup solutions for managed service providers
• 6Disaster recovery systems requiring offsite replication and encrypted storage
• 7Container volume backup for stateful applications in Docker and Kubernetes environments

Prerequisites

• Minimum 512MB RAM for small repositories, 2GB+ recommended for large datasets
• Sufficient disk space for Borg cache (typically 1-2% of total backup size)
• Network access to backup repositories if using remote storage destinations
• Understanding of Borg repository initialization and passphrase management
• Familiarity with YAML configuration syntax for borgmatic setup files
• SSH key configuration if backing up to remote repositories via SSH protocol

docker-compose.yml

1services: 
2  borgmatic: 
3    image: b3vis/borgmatic:latest
4    container_name: borgmatic
5    restart: unless-stopped
6    environment: 
7      - TZ=${TZ:-UTC}
8      - BORG_PASSPHRASE=${BORG_PASSPHRASE:-}
9    volumes: 
10      - ./borgmatic.d:/etc/borgmatic.d:ro
11      - ${SOURCE_PATH:-./source}:/mnt/source:ro
12      - ${REPO_PATH:-./repo}:/mnt/borg-repository
13      - borgmatic_config:/root/.config/borg
14      - borgmatic_cache:/root/.cache/borg
15    networks: 
16      - borgmatic-network
17
18volumes: 
19  borgmatic_config: 
20  borgmatic_cache: 
21
22networks: 
23  borgmatic-network: 
24    driver: bridge

.env Template

1# Borgmatic
2TZ=UTC
3BORG_PASSPHRASE=your-secure-passphrase
4SOURCE_PATH=./source
5REPO_PATH=./repo

Usage Notes

Quick Start

1# 1. Create the compose file
2cat > docker-compose.yml << 'EOF'
3services:
4  borgmatic:
5    image: b3vis/borgmatic:latest
6    container_name: borgmatic
7    restart: unless-stopped
8    environment:
9      - TZ=${TZ:-UTC}
10      - BORG_PASSPHRASE=${BORG_PASSPHRASE:-}
11    volumes:
12      - ./borgmatic.d:/etc/borgmatic.d:ro
13      - ${SOURCE_PATH:-./source}:/mnt/source:ro
14      - ${REPO_PATH:-./repo}:/mnt/borg-repository
15      - borgmatic_config:/root/.config/borg
16      - borgmatic_cache:/root/.cache/borg
17    networks:
18      - borgmatic-network
19
20volumes:
21  borgmatic_config:
22  borgmatic_cache:
23
24networks:
25  borgmatic-network:
26    driver: bridge
27EOF
28
29# 2. Create the .env file
30cat > .env << 'EOF'
31# Borgmatic
32TZ=UTC
33BORG_PASSPHRASE=your-secure-passphrase
34SOURCE_PATH=./source
35REPO_PATH=./repo
36EOF
37
38# 3. Start the services
39docker compose up -d
40
41# 4. View logs
42docker compose logs -f

One-Liner

Run this command to download and set up the recipe in one step:

1curl -fsSL https://docker.recipes/api/recipes/borgmatic-backup/run | bash

Troubleshooting