drone-s3-sync/README.md

53 lines
1.5 KiB
Markdown
Raw Normal View History

# 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)
2016-07-31 17:35:39 +00:00
[![Go Doc](https://godoc.org/github.com/drone-plugins/drone-s3-sync?status.svg)](http://godoc.org/github.com/drone-plugins/drone-s3-sync)
[![Go Report](https://goreportcard.com/badge/github.com/drone-plugins/drone-s3-sync)](https://goreportcard.com/report/github.com/drone-plugins/drone-s3-sync)
[![Join the chat at https://gitter.im/drone/drone](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/drone/drone)
2016-07-31 17:35:39 +00:00
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).
2016-07-22 00:27:25 +00:00
## Build
2016-07-22 00:27:25 +00:00
Build the binary with the following commands:
```
2016-07-31 17:35:39 +00:00
go build
go test
```
## Docker
2016-07-22 00:27:25 +00:00
Build the docker image with the following commands:
```
2016-07-31 17:35:39 +00:00
CGO_ENABLED=0 GOOS=linux GOARCH=amd64 go build -a -tags netgo
2016-07-22 00:27:25 +00:00
docker build --rm=true -t plugins/s3-sync .
```
2016-07-31 17:35:39 +00:00
Please note incorrectly building the image for the correct x64 linux and with
GCO disabled will result in an error when running the Docker image:
```
2016-07-22 00:27:25 +00:00
docker: Error response from daemon: Container command
'/bin/drone-s3-sync' not found or does not exist..
```
2016-07-22 00:27:25 +00:00
## Usage
2016-07-31 17:35:39 +00:00
Execute from the working directory:
2016-07-22 00:27:25 +00:00
2016-07-31 17:35:39 +00:00
```sh
2016-07-22 00:27:25 +00:00
docker run --rm \
2016-07-31 17:35:39 +00:00
-e PLUGIN_SOURCE=<source> \
-e PLUGIN_TARGET=<target> \
-e PLUGIN_BUCKET=<bucket> \
-e AWS_ACCESS_KEY_ID=<access_key> \
2016-07-22 00:27:25 +00:00
-e AWS_SECRET_ACCESS_KEY=<secret_key> \
2016-07-31 17:35:39 +00:00
-v $(pwd):$(pwd) \
-w $(pwd) \
2016-07-22 00:27:25 +00:00
plugins/s3-sync
```