scp-action/README.md

171 lines
4.2 KiB
Markdown
Raw Normal View History

2019-05-11 09:01:31 +00:00
# 🚀 SCP for GitHub Actions
2019-09-30 03:38:02 +00:00
[GitHub Action](https://github.com/features/actions) for copying files and artifacts via SSH.
2019-05-11 09:01:31 +00:00
2019-09-28 04:13:03 +00:00
![ssh key](./images/copy-multiple-file.png)
2019-05-11 09:01:31 +00:00
2019-09-28 04:17:08 +00:00
[![Actions Status](https://github.com/appleboy/scp-action/workflows/scp%20files/badge.svg)](https://github.com/appleboy/scp-action/actions)
2019-05-11 09:01:31 +00:00
## Usage
copy files and artifacts via SSH as blow.
2019-09-28 04:13:03 +00:00
```yaml
2019-09-29 06:16:22 +00:00
name: scp files
on: [push]
jobs:
build:
name: Build
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@master
- name: copy file via ssh password
uses: appleboy/scp-action@master
with:
host: ${{ secrets.HOST }}
username: ${{ secrets.USERNAME }}
password: ${{ secrets.PASSWORD }}
port: ${{ secrets.PORT }}
source: "tests/a.txt,tests/b.txt"
target: "test"
2019-05-11 09:01:31 +00:00
```
2019-09-28 04:16:21 +00:00
## Input variables
2019-05-11 11:49:38 +00:00
2019-09-28 04:16:21 +00:00
see the [action.yml](./action.yml) file for more detail imformation.
* host - scp remote host
* port - scp remote port, default is `22`
2019-09-28 04:16:21 +00:00
* username - scp username
* password - scp password
2020-01-20 15:07:25 +00:00
* passphrase - the passphrase is usually to encrypt the private key
2019-09-28 17:45:56 +00:00
* timeout - timeout for ssh to remote host, default is `30s`
* command_timeout - timeout for scp command, default is `10m`
2019-09-28 04:16:21 +00:00
* key - content of ssh private key. ex raw content of ~/.ssh/id_rsa
* key_path - path of ssh private key
* target - target path on the server
* source - scp file list
2020-02-25 15:47:04 +00:00
* rm - remove target folder before upload data, default is `false`
2019-09-28 04:26:40 +00:00
* strip_components - remove the specified number of leading path elements.
* overwrite - use `--overwrite` flag with tar
* tar_tmp_path - temporary path for tar file on the dest host
2019-05-11 11:49:38 +00:00
2020-01-20 15:08:15 +00:00
SSH Proxy Setting:
* proxy_host - proxy host
* proxy_port - proxy port, default is `22`
* proxy_username - proxy username
* proxy_password - proxy password
* proxy_passphrase - the passphrase is usually to encrypt the private key
* proxy_timeout - timeout for ssh to proxy host, default is `30s`
* proxy_key - content of ssh proxy private key.
* proxy_key_path - path of ssh proxy private key
2019-05-11 09:01:31 +00:00
### Example
2019-05-11 11:49:38 +00:00
Copy file via ssh password
2019-09-28 04:13:03 +00:00
```yaml
- name: copy file via ssh password
uses: appleboy/scp-action@master
with:
host: example.com
username: foo
password: bar
port: 22
source: "tests/a.txt,tests/b.txt"
target: "test"
2019-05-11 09:01:31 +00:00
```
2019-05-11 11:49:38 +00:00
Copy file via ssh key
2019-09-28 04:13:03 +00:00
```yaml
- name: copy file via ssh key
uses: appleboy/scp-action@master
env:
HOST: ${{ secrets.HOST }}
USERNAME: ${{ secrets.USERNAME }}
PORT: ${{ secrets.PORT }}
KEY: ${{ secrets.KEY }}
with:
source: "tests/a.txt,tests/b.txt"
target: "test"
2019-05-11 11:49:38 +00:00
```
Example configuration for ignore list:
2019-09-28 04:13:03 +00:00
```yaml
- name: copy file via ssh key
uses: appleboy/scp-action@master
env:
HOST: ${{ secrets.HOST }}
USERNAME: ${{ secrets.USERNAME }}
PORT: ${{ secrets.PORT }}
KEY: ${{ secrets.KEY }}
with:
source: "tests/*.txt,!tests/a.txt"
target: "test"
2019-05-11 11:49:38 +00:00
```
2019-05-12 02:25:37 +00:00
Example configuration for multiple server
```diff
2019-09-28 04:13:03 +00:00
uses: appleboy/scp-action@master
with:
- host: "example.com"
+ host: "foo.com,bar.com"
username: foo
password: bar
port: 22
source: "tests/a.txt,tests/b.txt"
target: "test"
2019-05-12 02:25:37 +00:00
```
2019-09-28 04:26:40 +00:00
remove the specified number of leading path elements
```yaml
- name: remove the specified number of leading path elements
uses: appleboy/scp-action@master
with:
host: ${{ secrets.HOST }}
username: ${{ secrets.USERNAME }}
key: ${{ secrets.KEY }}
port: ${{ secrets.PORT }}
source: "tests/a.txt,tests/b.txt"
target: "foobar"
strip_components: 1
```
old target structure:
```sh
foobar
└── tests
├── a.txt
└── b.txt
```
new target structure:
```sh
foobar
├── a.txt
└── b.txt
```
2020-01-20 15:07:25 +00:00
Protecting a Private Key. The purpose of the passphrase is usually to encrypt the private key. This makes the key file by itself useless to an attacker. It is not uncommon for files to leak from backups or decommissioned hardware, and hackers commonly exfiltrate files from compromised systems.
```diff
- name: ssh key with passphrase
uses: appleboy/scp-action@master
with:
host: ${{ secrets.HOST }}
username: ${{ secrets.USERNAME }}
key: ${{ secrets.SSH2 }}
+ passphrase: ${{ secrets.PASSPHRASE }}
port: ${{ secrets.PORT }}
source: "tests/a.txt,tests/b.txt"
target: "test"
```