docs: sync parameter (#25)
This commit is contained in:
parent
73767290ca
commit
cfe9c45db6
17
README.md
17
README.md
|
@ -50,6 +50,7 @@ See [action.yml](./action.yml) for more detailed information.
|
||||||
* username - ssh username
|
* username - ssh username
|
||||||
* password - ssh password
|
* password - ssh password
|
||||||
* passphrase - the passphrase is usually to encrypt the private key
|
* passphrase - the passphrase is usually to encrypt the private key
|
||||||
|
* sync - synchronous execution if multiple hosts, default is false
|
||||||
* timeout - timeout for ssh to remote host, default is `30s`
|
* timeout - timeout for ssh to remote host, default is `30s`
|
||||||
* command_timeout - timeout for ssh command, default is `10m`
|
* command_timeout - timeout for ssh command, default is `10m`
|
||||||
* key - content of ssh private key. ex raw content of ~/.ssh/id_rsa
|
* key - content of ssh private key. ex raw content of ~/.ssh/id_rsa
|
||||||
|
@ -131,6 +132,22 @@ Multiple Hosts
|
||||||
ls -al
|
ls -al
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Synchronous execution on multiple hosts
|
||||||
|
|
||||||
|
```diff
|
||||||
|
- name: multiple host
|
||||||
|
uses: appleboy/ssh-action@master
|
||||||
|
with:
|
||||||
|
host: "foo.com,bar.com"
|
||||||
|
+ sync: true
|
||||||
|
username: ${{ secrets.USERNAME }}
|
||||||
|
key: ${{ secrets.KEY }}
|
||||||
|
port: ${{ secrets.PORT }}
|
||||||
|
script: |
|
||||||
|
whoami
|
||||||
|
ls -al
|
||||||
|
```
|
||||||
|
|
||||||
Pass environment variable to shell script
|
Pass environment variable to shell script
|
||||||
|
|
||||||
```diff
|
```diff
|
||||||
|
|
|
@ -13,6 +13,9 @@ inputs:
|
||||||
description: 'ssh username'
|
description: 'ssh username'
|
||||||
password:
|
password:
|
||||||
description: 'ssh password'
|
description: 'ssh password'
|
||||||
|
sync:
|
||||||
|
description: 'synchronous execution if multiple hosts'
|
||||||
|
default: false
|
||||||
timeout:
|
timeout:
|
||||||
description: 'timeout for ssh to remote host'
|
description: 'timeout for ssh to remote host'
|
||||||
default: "30s"
|
default: "30s"
|
||||||
|
|
Loading…
Reference in New Issue