diff --git a/README.md b/README.md index 8be7096..a92b0da 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ [![GoDoc](https://godoc.org/github.com/appleboy/drone-scp?status.svg)](https://godoc.org/github.com/appleboy/drone-scp) [![Build Status](http://drone.wu-boy.com/api/badges/appleboy/drone-scp/status.svg)](http://drone.wu-boy.com/appleboy/drone-scp) [![codecov](https://codecov.io/gh/appleboy/drone-scp/branch/master/graph/badge.svg)](https://codecov.io/gh/appleboy/drone-scp) [![Go Report Card](https://goreportcard.com/badge/github.com/appleboy/drone-scp)](https://goreportcard.com/report/github.com/appleboy/drone-scp) [![Docker Pulls](https://img.shields.io/docker/pulls/appleboy/drone-scp.svg)](https://hub.docker.com/r/appleboy/drone-scp/) [![](https://images.microbadger.com/badges/image/appleboy/drone-scp.svg)](https://microbadger.com/images/appleboy/drone-scp "Get your own image badge on microbadger.com") -[Drone](https://github.com/drone/drone) plugin to copy files and artifacts via SSH. +Copy files and artifacts via SSH using a binary, docker or [Drone CI](http://readme.drone.io/0.5/). ## Feature @@ -61,23 +61,23 @@ There are three ways to send notification. #### Using public key ```bash -drone-scp --host=example.com \ - --port=22 \ - --username=appleboy \ - --key-path="${HOME}/.ssh/id_rsa" \ - --target=/home/appleboy/test \ - --source=your_local_folder_path +drone-scp --host example.com \ + --port 22 \ + --username appleboy \ + --key-path "${HOME}/.ssh/id_rsa" \ + --target /home/appleboy/test \ + --source your_local_folder_path ``` #### Using password ```diff -drone-scp --host=example.com \ - --port=22 \ - --username=appleboy \ -+ --password=xxxxxxx \ - --target=/home/appleboy/test \ - --source=your_local_folder_path +drone-scp --host example.com \ + --port 22 \ + --username appleboy \ ++ --password xxxxxxx \ + --target /home/appleboy/test \ + --source your_local_folder_path ``` #### Using ssh-agent @@ -97,25 +97,25 @@ $ ssh-add You don't need to add `--password` or `--key-path` arguments. ```bash -drone-scp --host=example.com \ - --port=22 \ - --username=appleboy \ - --target=/home/appleboy/test \ - --source=your_local_folder_path +drone-scp --host example.com \ + --port 22 \ + --username appleboy \ + --target /home/appleboy/test \ + --source your_local_folder_path ``` #### Send multiple source or target folder and hosts ```diff -drone-scp --host=example1.com \ -+ --host=example2.com \ - --port=22 \ - --username=appleboy \ - --password= xxxxxxx - --target=/home/appleboy/test1 \ -+ --target=/home/appleboy/test2 \ - --source=your_local_folder_path_1 -+ --source=your_local_folder_path_2 +drone-scp --host example1.com \ ++ --host example2.com \ + --port 22 \ + --username appleboy \ + --password xxxxxxx + --target /home/appleboy/test1 \ ++ --target /home/appleboy/test2 \ + --source your_local_folder_path_1 ++ --source your_local_folder_path_2 ``` @@ -125,12 +125,12 @@ drone-scp --host=example1.com \ ```bash docker run --rm \ - -e SCP_HOST=example.com \ - -e SCP_USERNAME=xxxxxxx \ - -e SCP_PORT=22 \ - -e SCP_KEY_PATH="${HOME}/.ssh/id_rsa" - -e SCP_SOURCE=SOURCE_FILE_LIST \ - -e SCP_TARGET=TARGET_FOLDER_PATH \ + -e SCP_HOST example.com \ + -e SCP_USERNAME xxxxxxx \ + -e SCP_PORT 22 \ + -e SCP_KEY_PATH "${HOME}/.ssh/id_rsa" + -e SCP_SOURCE SOURCE_FILE_LIST \ + -e SCP_TARGET TARGET_FOLDER_PATH \ -v $(pwd):$(pwd) \ -w $(pwd) \ appleboy/drone-scp @@ -140,12 +140,12 @@ docker run --rm \ ```diff docker run --rm \ - -e SCP_HOST=example.com \ - -e SCP_USERNAME=xxxxxxx \ - -e SCP_PORT=22 \ -+ -e SCP_PASSWORD="xxxxxxx" - -e SCP_SOURCE=SOURCE_FILE_LIST \ - -e SCP_TARGET=TARGET_FOLDER_PATH \ + -e SCP_HOST example.com \ + -e SCP_USERNAME xxxxxxx \ + -e SCP_PORT 22 \ ++ -e SCP_PASSWORD "xxxxxxx" + -e SCP_SOURCE SOURCE_FILE_LIST \ + -e SCP_TARGET TARGET_FOLDER_PATH \ -v $(pwd):$(pwd) \ -w $(pwd) \ appleboy/drone-scp @@ -169,11 +169,11 @@ You don't need to add `SCP_PASSWORD` or `SCP_KEY_PATH ` arguments. ```bash docker run --rm \ - -e SCP_HOST=example.com \ - -e SCP_USERNAME=xxxxxxx \ - -e SCP_PORT=22 \ - -e SCP_SOURCE=SOURCE_FILE_LIST \ - -e SCP_TARGET=TARGET_FOLDER_PATH \ + -e SCP_HOST example.com \ + -e SCP_USERNAME xxxxxxx \ + -e SCP_PORT 22 \ + -e SCP_SOURCE SOURCE_FILE_LIST \ + -e SCP_TARGET TARGET_FOLDER_PATH \ -v $(pwd):$(pwd) \ -w $(pwd) \ appleboy/drone-scp @@ -183,12 +183,12 @@ docker run --rm \ ```bash docker run --rm \ - -e SCP_HOST=example1.com,example2.com \ - -e SCP_USERNAME=xxxxxxx \ - -e SCP_PASSWORD=xxxxxxx \ - -e SCP_PORT=22 \ - -e SCP_SOURCE=SOURCE_FILE_LIST_1,SOURCE_FILE_LIST_2 \ - -e SCP_TARGET=TARGET_FOLDER_PATH_1,TARGET_FOLDER_PATH_2 \ + -e SCP_HOST example1.com,example2.com \ + -e SCP_USERNAME xxxxxxx \ + -e SCP_PASSWORD xxxxxxx \ + -e SCP_PORT 22 \ + -e SCP_SOURCE SOURCE_FILE_LIST_1,SOURCE_FILE_LIST_2 \ + -e SCP_TARGET TARGET_FOLDER_PATH_1,TARGET_FOLDER_PATH_2 \ -v $(pwd):$(pwd) \ -w $(pwd) \ appleboy/drone-scp @@ -201,23 +201,23 @@ Execute from the working directory: ```bash docker run --rm \ - -e PLUGIN_HOST=example.com \ - -e PLUGIN_USERNAME=xxxxxxx \ - -e PLUGIN_PASSWORD=xxxxxxx \ - -e PLUGIN_PORT=xxxxxxx \ - -e PLUGIN_KEY="$(cat ${HOME}/.ssh/id_rsa)" - -e PLUGIN_SOURCE=SOURCE_FILE_LIST \ - -e PLUGIN_TARGET=TARGET_FOLDER_PATH \ - -e PLUGIN_RM=false \ - -e PLUGIN_DEBUG=false \ - -e DRONE_REPO_OWNER=appleboy \ - -e DRONE_REPO_NAME=go-hello \ - -e DRONE_COMMIT_SHA=e5e82b5eb3737205c25955dcc3dcacc839b7be52 \ - -e DRONE_COMMIT_BRANCH=master \ - -e DRONE_COMMIT_AUTHOR=appleboy \ - -e DRONE_BUILD_NUMBER=1 \ - -e DRONE_BUILD_STATUS=success \ - -e DRONE_BUILD_LINK=http://github.com/appleboy/go-hello \ + -e PLUGIN_HOST example.com \ + -e PLUGIN_USERNAME xxxxxxx \ + -e PLUGIN_PASSWORD xxxxxxx \ + -e PLUGIN_PORT xxxxxxx \ + -e PLUGIN_KEY "$(cat ${HOME}/.ssh/id_rsa)" + -e PLUGIN_SOURCE SOURCE_FILE_LIST \ + -e PLUGIN_TARGET TARGET_FOLDER_PATH \ + -e PLUGIN_RM false \ + -e PLUGIN_DEBUG false \ + -e DRONE_REPO_OWNER appleboy \ + -e DRONE_REPO_NAME go-hello \ + -e DRONE_COMMIT_SHA e5e82b5eb3737205c25955dcc3dcacc839b7be52 \ + -e DRONE_COMMIT_BRANCH master \ + -e DRONE_COMMIT_AUTHOR appleboy \ + -e DRONE_BUILD_NUMBER 1 \ + -e DRONE_BUILD_STATUS success \ + -e DRONE_BUILD_LINK http://github.com/appleboy/go-hello \ -v $(pwd):$(pwd) \ -w $(pwd) \ appleboy/drone-scp