https://github.com/lminlone/repliqate
A modular Docker container backup solution
https://github.com/lminlone/repliqate
backup devops docker foss restic
Last synced: about 1 month ago
JSON representation
A modular Docker container backup solution
- Host: GitHub
- URL: https://github.com/lminlone/repliqate
- Owner: lminlone
- License: mit
- Created: 2025-08-25T12:29:17.000Z (about 1 month ago)
- Default Branch: master
- Last Pushed: 2025-09-04T01:10:05.000Z (about 1 month ago)
- Last Synced: 2025-09-04T03:12:49.330Z (about 1 month ago)
- Topics: backup, devops, docker, foss, restic
- Language: C#
- Homepage:
- Size: 36.2 MB
- Stars: 75
- Watchers: 0
- Forks: 1
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Repliqate is a modular backup solution designed for Docker environments. It safely handles containerized workloads by stopping and restarting containers during backup operations, ensuring data consistency.
Currently, Repliqate integrates with Restic as its backup engine, with planned support for additional providers in the future.
# Features
- **Label-based configuration**: Configure backup rules using Docker container **and volume** labels, keeping configuration alongside the resources it protects.
- **Self-hostable**: Deployable as a Docker container for integration into existing infrastructure.
- **Container-safe**: Automatically stops and restarts containers around backup operations.
- **Versioned backups**: Maintains version history of backups with configurable retention policies, allowing recovery from multiple points in time.
- **Intuitive scheduling**: Simple, human-readable schedule configuration with convenient shortcuts like `@daily 3am` or `@weekly 4am Mon`, while still supporting traditional cron expressions for advanced use cases.
# Running Repliqate
## Prerequisites
- Docker Engine 24.0 or later
- Access to container runtime socket
- Storage location for backup data
## shell
```shell
docker run -d \
--name repliqate \
-v /var/run/docker.sock:/var/run/docker.sock \
-v /path/to/backups:/var/repliqate \
-v /var/lib/docker/volumes:/var/lib/docker/volumes \
lminlone/repliqate
```
## Docker Compose
```yml
services:
repliqate:
image: lminlone/repliqate
container_name: repliqate
volumes:
- /var/run/docker.sock:/var/run/docker.sock
- /path/to/backups:/var/repliqate
- /var/lib/docker/volumes:/var/lib/docker/volumes
```
Or, if you wish to backup to an NFS:
```yml
services:
repliqate:
image: lminlone/repliqate
container_name: repliqate
volumes:
- /var/run/docker.sock:/var/run/docker.sock
- backups:/var/repliqate
- /var/lib/docker/volumes:/var/lib/docker/volumes
volumes:
backups:
driver: local
driver_opts:
type: nfs
o: addr=your-nas-hostname-or-ip,nolock,soft,rw
device: :/volume/backups
```
## Options, Volumes & Environment Variables
### Volumes
- `/var/run/docker.sock`: Required so Repliqate can read labels and control containers.
- `/app/repliqate`: Storage for metadata and backup files.
- `/var/lib/docker/volume`: Repliqate needs direct access to the volume data to be able to back it up. It's possible to give individual access to each volume directly to repliqate without exposing all your volumes: eg `/var/lib/docker/volume/my_volume_name:/var/lib/docker/volume/my_volume_name`. You'd need to do this per volume if this is the case.
### Environment Variable(s)
| Variable | Description | Required | Default |
|--------------------|-----------------------------------------------------------------------------------------------------------------------|----------|------------------------|
| `BACKUP_ROOT_PATH` | The directory in which the backups are placed. | No | `/var/repliqate` |
| `DOCKER_SOCK_PATH` | The Docker URI. Defaults to `/var/run/docker.sock`. Can contain `tcp://` connections if required but not recommended. | No | `/var/run/docker.sock` |
| `TZ` | Sets the timezone of the container | No | `UTC` |
# Backup Configuration
Repliqate uses Docker labels for configuration. This keeps backup policies close to the containers and volumes they apply to, eliminating the need for separate configuration files.
## Container Labels
| Label | Description | Default | Example |
|--------------------------|----------------------------------------------------------------------------------------------------------------------------------------|----------|------------------------------------------------------|
| `repliqate.enabled` | Enables backup for the container | `false` | `true` |
| `repliqate.engine` | Backup engine selection | `restic` | `restic` |
| `repliqate.schedule` | Backup schedule (cron format) | `none` | `@daily 3am` (see [Scheduling](#scheduling) section) |
| `repliqate.backup_id` | Unique backup identifier for the container.
**NOTE**: Ensure this is fully unique across all containers on the docker server. | `none` | `prod-db-01` |
| `repliqate.retention` | Amount of backups to keep. (Currently WIP) | `10` | `3` |
## Volume Labels
| Label | Description | Default |
|----------------------|-----------------------------------------------|-----------|
| `repliqate.exclude` | Exclude this volume from container backups. | `false` |
## Examples
Example 1 (Simple)
```shell
docker run -d \
--label repliqate.enabled=true \
--label repliqate.engine=restic \
--label repliqate.schedule="@daily 3am" \
--label repliqate.backup_id=my_app_01 \
--name my_app \
my_image:latest
```
Example 2 (A bit more complex)
```yml
services:
app:
image: my-app:latest
volumes:
- data:/my-app/data
- uploads:/my-app/uploads
labels:
repliqate.enabled: 'true'
repliqate.schedule: "@daily 10:34"
repliqate.engine: restic
repliqate.backup_id: my_app
volumes:
data:
labels:
repliqate.exclude: 'true' # Exclude from being backed up
uploads:
```
# Scheduling
Repliqate provides flexible scheduling options using a (half-custom) syntax while maintaining compatibility with "standard" cron expressions.
## Shorthand Syntax
### Frequency Options
- `@daily
### Time Formats
Supports both 12-hour and 24-hour time formats:
- 12-hour: `3:00 PM`, `3PM`, `3:00pm`
- 24-hour: `15:00`
### Examples
- `@monthly 9am 15`: Run on the 15th of every month at 9am.
- `@weekly 4am Mon`: Run weekly on Mondays at 4am.
- `@daily 23:59`: Run every day at 11:59pm.
## Advanced Scheduling
For more complex scheduling needs, Repliqate also accepts [Quartz cron expressions](http://www.cronmaker.com)
### Examples
- `0 0 19 1/1 * ? *`: Run every hour (not recommended) starting at 7pm.
- `0 0 2 ? * MON-FRI *`: Run every weekday at 2am.
# Roadmap
- ☐ Support for additional backup engines (e.g., rclone, fully native solution, postgres DB dump, etc).
- ☐ Modular plugins to allow custom backup engines.
- ☐ Restoration options.
- ☐ Frontend UI for advanced configurations and restoration.
- ☐ Enhanced monitoring and logging options (such as for Grafana Loki or Graylog)
# Contributing
Contributions are welcome. Please open an issue to discuss proposed changes before submitting a pull request.
# License
Repliqate is licensed under the MIT License. See [LICENSE](License.md)