mirror of
https://github.com/appleboy/drone-ssh.git
synced 2025-05-09 18:23:21 +08:00
6d9d6acc6a
* Format parameter table * Format parameter keys as code * Add documentation of configuration overrides
126 lines
3.7 KiB
Markdown
126 lines
3.7 KiB
Markdown
# drone-ssh
|
|
|
|
|
|
|
|
[](https://github.com/appleboy/drone-ssh/releases)
|
|
[](https://godoc.org/github.com/appleboy/drone-ssh)
|
|
[](https://github.com/appleboy/drone-ssh/actions/workflows/lint.yml)
|
|
[](https://codecov.io/gh/appleboy/drone-ssh)
|
|
[](https://goreportcard.com/report/github.com/appleboy/drone-ssh)
|
|
[](https://hub.docker.com/r/appleboy/drone-ssh/)
|
|
|
|
Drone plugin to execute commands on a remote host through SSH. For the usage
|
|
information and a listing of the available options please take a look at [the docs](http://plugins.drone.io/appleboy/drone-ssh/).
|
|
|
|
**Note: Please update your image config path to `appleboy/drone-ssh` for drone. `plugins/ssh` is no longer maintained.**
|
|
|
|
|
|
|
|
## Breaking changes
|
|
|
|
`v1.5.0`: change command timeout flag to `Duration`. See the following setting:
|
|
|
|
```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
|
|
script:
|
|
- echo "Hello World"
|
|
```
|
|
|
|
## Build or Download a binary
|
|
|
|
The pre-compiled binaries can be downloaded from [release page](https://github.com/appleboy/drone-ssh/releases). Support the following OS type.
|
|
|
|
* Windows amd64/386
|
|
* Linux arm/amd64/386
|
|
* Darwin amd64/386
|
|
|
|
With `Go` installed
|
|
|
|
```sh
|
|
go get -u -v github.com/appleboy/drone-ssh
|
|
```
|
|
|
|
or build the binary with the following command:
|
|
|
|
```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-ssh .
|
|
```
|
|
|
|
## Docker
|
|
|
|
Build the docker image with the following commands:
|
|
|
|
```sh
|
|
make docker
|
|
```
|
|
|
|
## Usage
|
|
|
|
Execute from the working directory:
|
|
|
|
```sh
|
|
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) \
|
|
appleboy/drone-ssh
|
|
```
|
|
|
|
## Mount key from file path
|
|
|
|
Please make sure that enable the `trusted` mode in project setting for [drone 0.8 version](https://0-8-0.docs.drone.io/).
|
|
|
|
|
|
|
|
Mount private key in `volumes` setting of `.drone.yml` config
|
|
|
|
```diff
|
|
pipeline:
|
|
ssh:
|
|
image: 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"
|
|
```
|
|
|
|
See the detail of [issue comment](https://github.com/appleboy/drone-ssh/issues/51#issuecomment-336732928).
|
|
|
|
## Configuration
|
|
|
|
See [DOCS.md](./DOCS.md) for examples and full configuration options
|
|
|
|
Configuration options are loaded from multiple sources:
|
|
|
|
0. Hardcoded drone-ssh defaults. See [main.go CLI Flags](https://github.com/albertyw/drone-ssh/blob/master/main.go#L39) for more information.
|
|
1. From a `.env` [dotenv](https://github.com/joho/godotenv) file at the root of the repository tested by drone.
|
|
2. From a dotenv file at a path specified by the `PLUGIN_ENV_FILE` environment variable.
|
|
3. From your `.drone.yml` Drone configuration.
|
|
|
|
Later sources override previous sources, i.e. if `PORT` is set in an `.env` file committed in the repository or created by previous test steps, it will override the default set `main.go`.
|