Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
yunussandikci authored Jun 23, 2020
1 parent ff728df commit 7c17ee5
Showing 1 changed file with 36 additions and 1 deletion.
37 changes: 36 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1 +1,36 @@
# cron-backups
# ⏱️📦 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: "<dropbox_token>"
```

0 comments on commit 7c17ee5

Please sign in to comment.