diff --git a/DOCS.md b/DOCS.md index 116d8a7..a4834c6 100644 --- a/DOCS.md +++ b/DOCS.md @@ -68,3 +68,23 @@ The example above illustrates a situation where an app package (`app.tar.gz`) wi ## Important The script passed to **script** will be executed on remote machines directly after rsync completes to deploy the files. It will be executed step by step until a command returns a non-zero exit-code. If this happens, the entire plugin will exit and fail the build. + + +## Key in drone >= 0.7 + +For drone 0.7 or drone 0.8: +register your key with: +``` bash +drone secret update \ + --repository your/repo \ + --name plugin_key \ + --value @./id_rsa.pub \ + --image drillster/drone-rsync +``` + +Do not add a `key` entry in `.drone`, but add: +``` +secrets: [ plugin_key ] +``` + +Using any other name will not work. diff --git a/README.md b/README.md index 1b84f45..0dbd322 100644 --- a/README.md +++ b/README.md @@ -1,7 +1,7 @@ # 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. +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).