cicd/drone-ssh
1
0
Fork 0
mirror of https://github.com/appleboy/drone-ssh.git synced 2025-05-09 18:23:21 +08:00
Code Issues Packages Projects Releases 1 Wiki Activity

docs: update to drone 1.0

Browse Source 
Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>
This commit is contained in:
Bo-Yi Wu 2019-03-11 14:47:55 +08:00
parent 56b67e1314
commit e7fd9e9b89
1 changed files with 67 additions and 59 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
DOCS.md
View File

@ -14,6 +14,7 @@ Use the SSH plugin to execute commands on a remote server. The below pipeline co
pipeline:
ssh:
image: appleboy/drone-ssh
settings:
host: foo.com
username: root
password: 1234
@ -29,6 +30,7 @@ Example configuration in your `.drone.yml` file for multiple hosts:
pipeline:
ssh:
image: appleboy/drone-ssh
settings:
host:
+ - foo.com
+ - bar.com
@ -40,17 +42,18 @@ pipeline:
- echo world
```
Example configuration for command timeout (unit: second), default value is 60 seconds:
Example configuration for command timeout, default value is 60 seconds:
```diff
pipeline:
ssh:
image: appleboy/drone-ssh
settings:
host: foo.com
username: root
password: 1234
port: 22
+ command_timeout: 120
+ command_timeout: 2m
script:
- echo hello
- echo world
@ -62,6 +65,7 @@ Example configuration for execute commands on a remote server using ｀SSHProxyC
pipeline:
ssh:
image: appleboy/drone-ssh
settings:
host: foo.com
username: root
password: 1234
@ -81,11 +85,12 @@ Example configuration using password from secrets:
pipeline:
ssh:
image: appleboy/drone-ssh
settings:
host: foo.com
username: root
- password: 1234
+ password:
+ from_secret: ssh_password
port: 22
+ secrets: [ ssh_password ]
script:
- echo hello
- echo world
@ -97,10 +102,12 @@ Example configuration using ssh key from secrets:
pipeline:
ssh:
image: appleboy/drone-ssh
settings:
host: foo.com
username: root
port: 22
+ secrets: [ ssh_key ]
+ key:
+ from_secret: ssh_key
script:
- echo hello
- echo world
@ -112,12 +119,13 @@ Example configuration for exporting custom secrets:
pipeline:
ssh:
image: appleboy/drone-ssh
settings:
host: foo.com
username: root
password: 1234
port: 22
+ secrets: [ aws_access_key_id ]
+ envs: [ aws_access_key_id ]
+ envs:
- aws_access_key_id
script:
- export AWS_ACCESS_KEY_ID=$AWS_ACCESS_KEY_ID
```