cicd/drone-ssh
1
0
Fork 0
mirror of https://github.com/appleboy/drone-ssh.git synced 2025-07-02 21:52:51 +08:00
Code Issues Packages Projects Releases 1 Wiki Activity

docs: update drone document

Browse Source 
fix: https://github.com/appleboy/drone-ssh/issues/144
fix: https://github.com/appleboy/drone-ssh/issues/146
This commit is contained in:
Bo-Yi Wu 2019-09-29 12:29:29 +08:00
parent 79584d6cfa
commit 553894abe6
1 changed files with 76 additions and 86 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

18
DOCS.md
View File

@ -11,8 +11,7 @@ image: appleboy/drone-ssh
Use the SSH plugin to execute commands on a remote server. The below pipeline configuration demonstrates simple usage:
```yaml
pipeline:
ssh:
- name: ssh commands
image: appleboy/drone-ssh
settings:
host: foo.com
@ -27,8 +26,6 @@ pipeline:
Example configuration in your `.drone.yml` file for multiple hosts:
```diff
pipeline:
ssh:
image: appleboy/drone-ssh
settings:
host:
@ -45,8 +42,6 @@ pipeline:
Example configuration for command timeout, default value is 60 seconds:
```diff
pipeline:
ssh:
image: appleboy/drone-ssh
settings:
host: foo.com
@ -62,8 +57,6 @@ pipeline:
Example configuration for execute commands on a remote server using ｀SSHProxyCommand｀:
```diff
pipeline:
ssh:
image: appleboy/drone-ssh
settings:
host: foo.com
@ -82,8 +75,6 @@ pipeline:
Example configuration using password from secrets:
```diff
pipeline:
ssh:
image: appleboy/drone-ssh
settings:
host: foo.com
@ -99,8 +90,6 @@ pipeline:
Example configuration using ssh key from secrets:
```diff
pipeline:
ssh:
image: appleboy/drone-ssh
settings:
host: foo.com
@ -116,8 +105,6 @@ pipeline:
Example configuration for exporting custom secrets:
```diff
pipeline:
ssh:
image: appleboy/drone-ssh
settings:
host: foo.com
@ -176,6 +163,9 @@ envs
script
: execute commands on a remote server
script_stop
: stop script after first failure
timeout
: Timeout is the maximum amount of time for the TCP connection to establish.