ssh-action/README.md
Bo-Yi Wu b2e4f0522d update example.
Signed-off-by: Bo-Yi Wu <appleboy.tw@gmail.com>
2019-05-15 06:36:27 +08:00

36 lines
686 B
Markdown

# 🚀 SSH for GitHub Actions
[GitHub Action](https://developer.github.com/actions/) for executing remote ssh commands.
<img src="./images/ssh-workflow.png">
## Usage
Executing remote ssh commands.
```
action "Copy multiple file" {
uses = "appleboy/scp-action@master"
env = {
HOST = "example.com"
USERNAME = "foo"
PASSWORD = "bar"
PORT = "22"
SOURCE = "tests/a.txt,tests/b.txt"
TARGET = "/home/foo/test"
}
secrets = [
"PASSWORD",
]
}
```
## Environment variables
* HOST - ssh server host
* PORT - ssh server port
* USERNAME - ssh server username
* PASSWORD - ssh server password
* KEY - ssh server private key
* SCRIPT - execute the scripts