Docker image to periodically run a scheduled backup using the RClone API
- Go 95.4%
- Go Template 3.1%
- Dockerfile 1.5%
George Grainger
ab01fc233c
All checks were successful
Docker Image CI / build (push) Successful in 29s
|
||
|---|---|---|
| .forgejo/workflows | ||
| templates | ||
| .dockerignore | ||
| .gitignore | ||
| compose.yml | ||
| Dockerfile | ||
| go.mod | ||
| go.sum | ||
| gotify.go | ||
| main.go | ||
| notifier.go | ||
| rclone.go | ||
| README.md | ||
| scheduler.go | ||
| storage.go | ||
| util.go | ||
Rclone-Scheduler
Docker image to schedule a regular rclone backup using the rclone API
Configuration
Configuration is done through environment variables
Please note that rclone can be configured entirely through environment variables, so this image DOES NOT configure any filters or other parameters when calling the Rclone API.
Rclone connection variables
| Variable | Description | Default |
|---|---|---|
| RCLONE_HOST | Host in which the rclone daemon is running | localhost |
| RCLONE_PORT | Port in which the rclone daemon is listening | 5572 |
| RCLONE_PROTOCOL | The protocol to use (http, or https) |
https |
Backup config variables
Configuration for backup operation.
Bear in mind all paths are used by the Rclone daemon and not this script
| Variable | Description | Default |
|---|---|---|
| BACKUP_SCHEDULE | The cron schedule to run the backup on | 0 0 * * 0 |
| BACKUP_SOURCE | Source to get the data from | /data |
| BACKUP_REMOTE | The remote to use as a destination when backing up | remote |
| BACKUP_DEST | The destination of the backup on the remote | /backup |
Restoring a backup
TODO
Currently this setup does not support the restoration of files from a remote.