drone-ssh

英文 | 繁體中文 | 简体中文

Drone插件，用于通过SSH在远程主机上执行命令。有关使用说明和可用选项列表，请参阅文档。

[!NOTE] 请将您的Drone镜像配置路径更新为 appleboy/drone-ssh。plugins/ssh 镜像已不再维护。

目录

• drone-ssh
• 目录
• Breaking Changes
• Build or Download a Binary
• Docker
• Usage
• Mount Key from File Path
• Configuration

Breaking Changes

从 v1.5.0 版本开始，命令超时标志已更改为使用 Duration 格式。请参见以下示例：

pipeline:
scp:
image: ghcr.io/appleboy/drone-ssh
settings:
host:
- example1.com
- example2.com
username: ubuntu
password:
from_secret: ssh_password
port: 22
- command_timeout: 120
+ command_timeout: 2m
script:
- echo "Hello World"

Build or Download a Binary

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

• Windows amd64/386
• Linux arm/amd64/386
• macOS (Darwin) amd64/386

如果已安装 Go：

go install github.com/appleboy/drone-ssh@latest

或通过以下命令手动构建二进制文件：

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-ssh .

Docker

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

make docker

Usage

从工作目录运行：

docker run --rm \
-e PLUGIN_HOST=foo.com \
-e PLUGIN_USERNAME=root \
-e PLUGIN_KEY="$(cat ${HOME}/.ssh/id_rsa)" \
-e PLUGIN_SCRIPT=whoami \
-v $(pwd):$(pwd) \
-w $(pwd) \
ghcr.io/appleboy/drone-ssh

Mount Key from File Path

确保在项目设置中启用 trusted 模式（适用于Drone 0.8 版本）。

在 .drone.yml 配置的 volumes 部分挂载私钥：

pipeline:
ssh:
image: ghcr.io/appleboy/drone-ssh
host: xxxxx.com
username: deploy
+ volumes:
+ - /root/drone_rsa:/root/ssh/drone_rsa
key_path: /root/ssh/drone_rsa
script:
- echo "test ssh"

详见https://github.com/appleboy/drone-ssh/issues/51#issuecomment-336732928%E3%80%82

Configuration

有关示例和完整配置选项，请参阅 DOCS.md。

配置选项从多个来源加载：

0. drone-ssh的硬编码默认值。有关更多信息，请参阅 https://github.com/appleboy/drone-ssh/blob/6d9d6acc6aef1f9166118c6ba8bd214d3a582bdb/main.go#L39%E3%80%82
1. 由 PLUGIN_ENV_FILE 环境变量指定路径的dotenv文件。
2. Drone配置文件 .drone.yml。

后续来源会覆盖先前来源。例如，如果 PORT 在仓库中提交的 .env 文件中设置，或由先前的测试步骤创建，它将覆盖 main.go 中设置的默认值。