From 7c17ee5e2aaedf3617cc656ca2e0bb8e19728e6b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Yunus=20Sand=C4=B1kc=C4=B1?= Date: Tue, 23 Jun 2020 20:36:07 +0300 Subject: [PATCH] Update README.md --- README.md | 37 ++++++++++++++++++++++++++++++++++++- 1 file changed, 36 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index d50482b..f944c9e 100644 --- a/README.md +++ b/README.md @@ -1 +1,36 @@ -# cron-backups \ No newline at end of file +# ⏱️📦 Cron Backups +Cron backups is a docker image to automate periodic backups easily to Dropbox with only one Docker container! + +## Features +- Auto compression +- Periodic backups +- Multiple folder selection +- Tiny footprint (9Mb) +- Upload to Dropbox + +## Usage +You only need to set your backup folders and 2 environment variables. + +### Volumes +It backups every folder you mapped into `/backup` folder with volumes + +### Environment Variables +`CRON`: Crontab value to set period of backups. Ref: https://crontab.guru/ + +`DROPBOX_TOKEN`: Access Token you get for Dropbox folder. Ref: https://www.dropbox.com/developers/apps/create + +### Example +Edit docker-compose and run with `docker-compose up -d` +``` +version: '3' +services: + caddy: + image: yunussandikci/cron-backups + volumes: + - /Users/yunussandikci/Pictures/:/backup/Pictures + - /Users/yunussandikci/Downloads/:/backup/Downloads + - /Users/yunussandikCci/Documents/Zoom/:/backup/Zoom + environment: + CRON: "* * * * *" + DROPBOX_TOKEN: "" +```