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

Commit

Permalink
deprecate the repo
Browse files Browse the repository at this point in the history
  • Loading branch information
tifayuki committed Mar 31, 2017
1 parent b6af64b commit da35a02
Show file tree
Hide file tree
Showing 5 changed files with 3 additions and 141 deletions.
19 changes: 0 additions & 19 deletions Dockerfile

This file was deleted.

81 changes: 3 additions & 78 deletions README.md
@@ -1,82 +1,7 @@

# Dockup

[![Deploy to Tutum](https://s.tutum.co/deploy-to-tutum.svg)](https://dashboard.tutum.co/stack/deploy/)

Docker image to backup your Docker container volumes

Why the name? Docker + Backup = Dockup

# Usage

You have a container running with one or more volumes:

```
$ docker run -d --name mysql tutum/mysql
```

From executing a `$ docker inspect mysql` we see that this container has two volumes:

```
"Volumes": {
"/etc/mysql": {},
"/var/lib/mysql": {}
}
```

## Backup
Launch `dockup` container with the following flags:

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

The contents of `env.txt` being:

```
AWS_ACCESS_KEY_ID=<key_here>
AWS_SECRET_ACCESS_KEY=<secret_here>
AWS_DEFAULT_REGION=us-east-1
BACKUP_NAME=mysql
PATHS_TO_BACKUP=/etc/mysql /var/lib/mysql
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.


## Restore
To restore your data simply set the `RESTORE` environment variable to `true` - this will restore the latest backup from S3 to your volume.


## A note on Buckets

> [Bucket naming guidelines](http://docs.aws.amazon.com/cli/latest/userguide/using-s3-commands.html):
> "Bucket names must be unique and should be DNS compliant. Bucket names can contain lowercase letters, numbers, hyphens and periods. Bucket names can only start and end with a letter or number, and cannot contain a period next to a hyphen or another period."
These rules are enforced in some regions.


[AWS S3 Regions](http://docs.aws.amazon.com/general/latest/gr/rande.html#s3_region)

| Region name | Region |
| ------------------------- | -------------- |
| US Standard | us-east-1 |
| US West (Oregon) | us-west-2 |
| US West (N. California) | us-west-1 |
| EU (Ireland) | eu-west-1 |
| EU (Frankfurt) | eu-central-1 |
| Asia Pacific (Singapore) | ap-southeast-1 |
| Asia Pacific (Sydney) | ap-southeast-2 |
| Asia Pacific (Tokyo) | ap-northeast-1 |
| South America (Sao Paulo) | sa-east-1 |


To perform a restore launch the container with the RESTORE variable set to true
This repo is deprecated: we are not going to maintain it anymore.

You can visit [Docker Store](https://store.docker.com) to explore similar images.

![](http://s.tutum.co.s3.amazonaws.com/support/images/dockup-readme.png)
To access the last commit of the code, please switch to [master branch](https://github.com/tutumcloud/dockup/tree/master).
21 changes: 0 additions & 21 deletions backup.sh

This file was deleted.

10 changes: 0 additions & 10 deletions restore.sh

This file was deleted.

13 changes: 0 additions & 13 deletions tutum.yml

This file was deleted.

0 comments on commit da35a02

Please sign in to comment.