Skip to content

Commit

Permalink
Added some basic docs.
Browse files Browse the repository at this point in the history
  • Loading branch information
seeruk committed Jun 2, 2017
1 parent 585748f commit de0266e
Show file tree
Hide file tree
Showing 2 changed files with 45 additions and 2 deletions.
5 changes: 5 additions & 0 deletions Dockerfile
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,9 @@ WORKDIR /root/

COPY --from=0 /go/src/github.com/SeerUK/foldup/foldup .

RUN set -x \
&& apk add --update \
ca-certificates \
&& rm -rf /var/cache/apk/*

ENTRYPOINT ["/root/foldup"]
42 changes: 40 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,42 @@

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][1]. 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 back to backup is specified in the command. You could use it as it is shown above, or you could
also 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

* [x] "Sprint 0" (Travis, repo setup)
Expand All @@ -22,11 +58,13 @@ Backup folders as archives to durable cloud storage buckets.
* [x] Scheduling
* [x] CLI
* [x] Application output
* [ ] Docker image
* [ ] Documentation
* [x] Docker image
* [x] Documentation
* [ ] Encrypted backups (optional)


## License

MIT

[1]: https://developers.google.com/identity/protocols/application-default-credentials

0 comments on commit de0266e

Please sign in to comment.