mirror of
https://github.com/appleboy/drone-ssh.git
synced 2025-07-02 21:52:51 +08:00
docs: update drone document
fix: https://github.com/appleboy/drone-ssh/issues/144 fix: https://github.com/appleboy/drone-ssh/issues/146
This commit is contained in:
parent
79584d6cfa
commit
553894abe6
18
DOCS.md
18
DOCS.md
@ -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:
|
Use the SSH plugin to execute commands on a remote server. The below pipeline configuration demonstrates simple usage:
|
||||||
|
|
||||||
```yaml
|
```yaml
|
||||||
pipeline:
|
- name: ssh commands
|
||||||
ssh:
|
|
||||||
image: appleboy/drone-ssh
|
image: appleboy/drone-ssh
|
||||||
settings:
|
settings:
|
||||||
host: foo.com
|
host: foo.com
|
||||||
@ -27,8 +26,6 @@ pipeline:
|
|||||||
Example configuration in your `.drone.yml` file for multiple hosts:
|
Example configuration in your `.drone.yml` file for multiple hosts:
|
||||||
|
|
||||||
```diff
|
```diff
|
||||||
pipeline:
|
|
||||||
ssh:
|
|
||||||
image: appleboy/drone-ssh
|
image: appleboy/drone-ssh
|
||||||
settings:
|
settings:
|
||||||
host:
|
host:
|
||||||
@ -45,8 +42,6 @@ pipeline:
|
|||||||
Example configuration for command timeout, default value is 60 seconds:
|
Example configuration for command timeout, default value is 60 seconds:
|
||||||
|
|
||||||
```diff
|
```diff
|
||||||
pipeline:
|
|
||||||
ssh:
|
|
||||||
image: appleboy/drone-ssh
|
image: appleboy/drone-ssh
|
||||||
settings:
|
settings:
|
||||||
host: foo.com
|
host: foo.com
|
||||||
@ -62,8 +57,6 @@ pipeline:
|
|||||||
Example configuration for execute commands on a remote server using `SSHProxyCommand`:
|
Example configuration for execute commands on a remote server using `SSHProxyCommand`:
|
||||||
|
|
||||||
```diff
|
```diff
|
||||||
pipeline:
|
|
||||||
ssh:
|
|
||||||
image: appleboy/drone-ssh
|
image: appleboy/drone-ssh
|
||||||
settings:
|
settings:
|
||||||
host: foo.com
|
host: foo.com
|
||||||
@ -82,8 +75,6 @@ pipeline:
|
|||||||
Example configuration using password from secrets:
|
Example configuration using password from secrets:
|
||||||
|
|
||||||
```diff
|
```diff
|
||||||
pipeline:
|
|
||||||
ssh:
|
|
||||||
image: appleboy/drone-ssh
|
image: appleboy/drone-ssh
|
||||||
settings:
|
settings:
|
||||||
host: foo.com
|
host: foo.com
|
||||||
@ -99,8 +90,6 @@ pipeline:
|
|||||||
Example configuration using ssh key from secrets:
|
Example configuration using ssh key from secrets:
|
||||||
|
|
||||||
```diff
|
```diff
|
||||||
pipeline:
|
|
||||||
ssh:
|
|
||||||
image: appleboy/drone-ssh
|
image: appleboy/drone-ssh
|
||||||
settings:
|
settings:
|
||||||
host: foo.com
|
host: foo.com
|
||||||
@ -116,8 +105,6 @@ pipeline:
|
|||||||
Example configuration for exporting custom secrets:
|
Example configuration for exporting custom secrets:
|
||||||
|
|
||||||
```diff
|
```diff
|
||||||
pipeline:
|
|
||||||
ssh:
|
|
||||||
image: appleboy/drone-ssh
|
image: appleboy/drone-ssh
|
||||||
settings:
|
settings:
|
||||||
host: foo.com
|
host: foo.com
|
||||||
@ -176,6 +163,9 @@ envs
|
|||||||
script
|
script
|
||||||
: execute commands on a remote server
|
: execute commands on a remote server
|
||||||
|
|
||||||
|
script_stop
|
||||||
|
: stop script after first failure
|
||||||
|
|
||||||
timeout
|
timeout
|
||||||
: Timeout is the maximum amount of time for the TCP connection to establish.
|
: Timeout is the maximum amount of time for the TCP connection to establish.
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user