Add README and DOCS

This commit is contained in:
Michael de Wit
2016-12-29 16:53:27 +01:00
parent 9f7809fcb3
commit a51fa78868
2 changed files with 87 additions and 0 deletions

View File

@@ -1 +1,27 @@
# drone-rsync
[![drone-rsync on Docker Hub](https://img.shields.io/docker/automated/drillster/drone-rsync.svg)](https://hub.docker.com/r/drillster/drone-rsync/)
This is a pure Bash [Drone](https://github.com/drone/drone) 0.5 plugin to sync files to remote hosts.
For more information on how to use the plugin, please take a look at [the docs](https://github.com/Drillster/drone-rsync/blob/master/DOCS.md).
## Docker
Build the docker image by running:
```bash
docker build --rm=true -t drillster/drone-rsync .
```
## Usage
Execute from the working directory (assuming you have an SSH server running on 127.0.0.1:22):
```bash
docker run --rm \
-e PLUGIN_KEY=$(cat some-private-key) \
-e PLUGIN_HOSTS="127.0.0.1" \
-e PLUGIN_TARGET="./" \
-e PLUGIN_SCRIPT="echo \"Done!\"" \
-v $(pwd):$(pwd) \
-w $(pwd) \
drillster/drone-rsync
```