appleboy/drone-scp

drone-scp

![GoDoc]([] ![Build Status]([] ![codecov]([] ![Go Report Card]([]

通过SSH协议复制文件和制品的工具，支持在二进制、Docker或Drone CI环境中使用。

核心功能

• 支持并发处理
• 支持源文件列表的通配符模式
• 支持向多台主机发送文件
• 支持向单台主机的多个目标文件夹发送文件
• 支持从绝对路径或原始内容加载SSH密钥
• 支持SSH代理命令（ProxyCommand）

以下为网络拓扑示例：

sh
+--------+       +----------+      +-----------+
|  电脑  | <-->  | 跳转主机 | <--> | 目标服务器 |
+--------+       +----------+      +-----------+

                   或

+--------+       +----------+      +-----------+
|  电脑  | <-->  | 防火墙   | <--> | 目标服务器 |
+--------+       +----------+      +-----------+
192.168.1.5       121.1.2.3         10.10.29.68

重大变更

v1.5.0：将命令超时标志更改为Duration类型。配置示例如下：

diff
pipeline:
  scp:
    image: appleboy/drone-scp
    settings:
      host:
        - example1.com
        - example2.com
      username: ubuntu
      password:
        from_secret: ssh_password
      port: 22
-     command_timeout: 120
+     command_timeout: 2m
      target: /home/deploy/web
      source:
        - release/*.tar.gz

构建或下载二进制文件

预编译二进制文件可从https://github.com/appleboy/drone-scp/releases%E4%B8%8B%E8%BD%BD%E3%80%82%E6%94%AF%E6%8C%81%E4%BB%A5%E4%B8%8B%E6%93%8D%E4%BD%9C%E7%B3%BB%E7%BB%9F%E7%B1%BB%E5%9E%8B%EF%BC%9A

• Windows amd64/386
• Linux arm/amd64/386
• Darwin amd64/386

若已安装Go环境，可通过以下命令安装：

sh
go get -u -v github.com/appleboy/drone-scp

或使用以下命令构建二进制文件：

sh
export GOOS=linux
export GOARCH=amd64
export CGO_ENABLED=0
export GO111MODULE=on

go test -cover ./...

go build -v -a -tags netgo -o release/linux/amd64/drone-scp .

Docker构建

使用以下命令构建Docker镜像：

sh
make docker

使用方法

有三种发送文件的方式：

• 通过二进制使用
• 通过Docker使用
• 通过Drone CI使用

通过二进制使用

使用公钥

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

使用密码

diff
drone-scp --host example.com \
  --port 22 \
  --username appleboy \
+ --password xxxxxxx \
  --target /home/appleboy/test \
  --source your_local_folder_path

使用ssh-agent

启动本地ssh代理：

bash
eval `ssh-agent -s`

导入本地公钥~/.ssh/id_rsa：

sh
ssh-add

无需添加--password或--key-path参数：

bash
drone-scp --host example.com \
  --port 22 \
  --username appleboy \
  --target /home/appleboy/test \
  --source your_local_folder_path

发送多源、多目标文件夹或多主机

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

通过Docker使用

使用公钥

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 \
  -v $(pwd):$(pwd) \
  -w $(pwd) \
  appleboy/drone-scp

使用密码

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 \
  -v $(pwd):$(pwd) \
  -w $(pwd) \
  appleboy/drone-scp

使用ssh-agent

启动本地ssh代理：

bash
eval `ssh-agent -s`

导入本地公钥~/.ssh/id_rsa：

sh
ssh-add

无需添加SCP_PASSWORD或SCP_KEY_PATH参数：

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 \
  -v $(pwd):$(pwd) \
  -w $(pwd) \
  appleboy/drone-scp

发送多源、多目标文件夹或多主机

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 \
  -v $(pwd):$(pwd) \
  -w $(pwd) \
  appleboy/drone-scp

通过Drone CI使用

在工作目录中执行：

bash
docker run --rm \
  -e PLUGIN_HOST=example.com \
  -e PLUGIN_USERNAME=xxxxxxx \
  -e PLUGIN_PASSWORD=xxxxxxx \
  -e PLUGIN_PORT=xxxxxxx \
  -e PLUGIN_SOURCE=SOURCE_FILE_LIST \
  -e PLUGIN_TARGET=TARGET_FOLDER_PATH \
  -e PLUGIN_RM=false \
  -e PLUGIN_DEBUG=true \
  -v $(pwd):$(pwd) \
  -w $(pwd) \
  appleboy/drone-scp

有关如何在Drone中使用scp的更多信息，请参见插件文档。

测试

使用以下命令测试包：

sh
make test