foldup

module
v0.1.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jun 2, 2017 License: MIT

README

Foldup

Backup folders as archives to durable cloud storage buckets.

Usage

As a user, it's probably easiest to just use the Docker image:

docker run --rm \
    -v /path/to/backup:/backup \
    -v /path/to/google/creds.json:/root/creds.json \
    -e GOOGLE_APPLICATION_CREDENTIALS=/root/creds.json \ 
    seeruk/foldup \
    backup /backup \ 
        --bucket=backups-sierra
        --schedule="0 * * * *"

You must provide some credentials for GCS. The above example uses a service account key, mounting it into the container, then using the environment variable GOOGLE_APPLICATION_CREDENTIALS to specify the location of that key file.

The folder to backup is specified in the command. You could use it as it is shown above, or you could mount individual directories to a parent folder, like this:

docker run --rm \
    -v /1st/to/backup:/backup/1st \
    -v /2nd/to/backup:/backup/2nd \
    -v /3rd/to/backup:/backup/3rd \
    ...
    backup /backup \ 
    ...

Foldup backs up all folders in a folder, so you can use this approach easily in a Docker Compose environment, or any other environment where you may have several volumes to back up. This can be especially useful for backing up the built-in Docker volumes.

Todo

  • "Sprint 0" (Travis, repo setup)
  • Archiving (initially gzipped tarballs)
  • Storage (initially Google Cloud Storage)
  • Scheduling
  • CLI
  • Application output
  • Docker image
  • Documentation
  • Encrypted backups (optional)

License

MIT

Directories

Path Synopsis
cmd
pkg
storage/gcs
Package gcs provides interfaces and wraps calls for interacting with Google Cloud Storage.
Package gcs provides interfaces and wraps calls for interacting with Google Cloud Storage.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL