drone-s3-sync/README.md
2016-07-21 17:27:25 -07:00

51 lines
1.4 KiB
Markdown

# drone-s3-sync
[![Build Status](http://beta.drone.io/api/badges/drone-plugins/drone-s3-sync/status.svg)](http://beta.drone.io/drone-plugins/drone-s3-sync)
[![](https://badge.imagelayers.io/plugins/drone-s3-sync:latest.svg)](https://imagelayers.io/?images=plugins/drone-s3-sync:latest 'Get your own badge on imagelayers.io')
Drone plugin to synchronize a directory with an Amazon S3 Bucket. For the usage information and a listing of the available options please take a look at [the docs](DOCS.md).
## Build
Build the binary with the following commands:
```
export GO15VENDOREXPERIMENT=1
export GOOS=linux
export GOARCH=amd64
export CGO_ENABLED=0
go build -a -tags netgo
```
## Docker
Build the docker image with the following commands:
```
docker build --rm=true -t plugins/s3-sync .
```
Please note incorrectly building the image, with the wrong OS, architecture, or with CGO enabled will result in an error when running the Docker image:
```
docker: Error response from daemon: Container command
'/bin/drone-s3-sync' not found or does not exist..
```
## Usage
Build and publish from your current working directory:
```
docker run --rm \
-e PLUGIN_SOURCE=<source> \
-e PLUGIN_TARGET=<target> \
-e PLUGIN_BUCKET=<bucket> \
-e AWS_ACCESS_KEY_ID=<access_key> \
-e AWS_SECRET_ACCESS_KEY=<secret_key> \
-v $(pwd):$(pwd) \
-w $(pwd) \
plugins/s3-sync
```