Skip to content
This repository has been archived by the owner on May 4, 2021. It is now read-only.

Added CRON_TIME instructions #26

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 19 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,25 @@ S3_BUCKET_NAME=docker-backups.example.com
RESTORE=false
```

`dockup` will use your AWS credentials to create a new bucket with name as per the environment variable `S3_BUCKET_NAME`, or if not defined, using the default name `docker-backups.example.com`. The paths in `PATHS_TO_BACKUP` will be tarballed, gzipped, time-stamped and uploaded to the S3 bucket.
`dockup` will use your AWS credentials to create a new bucket with name as per the environment variable `S3_BUCKET_NAME`, or if not defined, using the default name `docker-backups.example.com`. The paths in `PATHS_TO_BACKUP` will be tarballed, gzipped, time-stamped and uploaded to the S3 bucket.

# Running Dockup as a Cron Job
It is also possible to start the container in detached mode and have it run as a cron job backup up your volumes on a schedule.

Add a new entry to the `env.txt` to enable cron jobs. The time format is the same as a normal crontab job entry.

````
CRON_TIME=0 6 * * *
```

Start the Dockup container with the `--detach` option in order to keep the container running.

```
$ docker run --detach \
--env-file env.txt \
--volumes-from mysql \
--name dockup tutum/dockup:latest
```


## Restore
Expand Down