Need help with scp-action?
Click the “chat” button below for chat support from the developer who created it, or find similar developers for support.

About the developer

appleboy
527 Stars 67 Forks MIT License 78 Commits 33 Opened issues

Description

GitHub Action that copy files and artifacts via SSH.

Services available

!
?

Need anything else?

Contributors list

# 1,070
compass
github-...
gcm
apns
71 commits
# 432,112
C
Java
github-...
scp
1 commit
# 386,742
CSS
angular...
react-a...
HTML
1 commit
# 173,052
github-...
github-...
PHP
sabnzbd
1 commit

🚀 SCP for GitHub Actions

GitHub Action for copying files and artifacts via SSH.

ssh key

Actions Status

Important: Only support Linux docker container.

Usage

Copy files and artifacts via SSH:

name: scp files
on: [push]
jobs:

build: name: Build runs-on: ubuntu-latest steps: - uses: actions/[email protected] - name: copy file via ssh password uses: appleboy/[email protected] with: host: ${{ secrets.HOST }} username: ${{ secrets.USERNAME }} password: ${{ secrets.PASSWORD }} port: ${{ secrets.PORT }} source: "tests/a.txt,tests/b.txt" target: "test"

Input variables

See the action.yml file for more detail information.

  • host - scp remote host
  • port - scp remote port, default is
    22
  • username - scp username
  • password - scp password
  • passphrase - the passphrase is usually to encrypt the private key
  • fingerprint - fingerprint SHA256 of the host public key, default is to skip verification
  • timeout - timeout for ssh to remote host, default is
    30s
  • command_timeout - timeout for scp command, default is
    10m
  • 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
  • rm - remove target folder before upload data, default is
    false
  • strip_components - remove the specified number of leading path elements.
  • overwrite - use
    --overwrite
    flag with tar
  • tartmppath - temporary path for tar file on the dest host
  • useinsecurecipher - include more ciphers with useinsecurecipher (see #15)

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.
  • proxykeypath - path of ssh proxy private key
  • proxy_fingerprint - fingerprint SHA256 of the host public key, default is to skip verification
  • proxyuseinsecurecipher - include more ciphers with useinsecure_cipher (see #15)

Example

Copy file via a SSH password:

- name: copy file via ssh password
  uses: appleboy/[email protected]
  with:
    host: example.com
    username: foo
    password: bar
    port: 22
    source: "tests/a.txt,tests/b.txt"
    target: "test"

Copy file via a SSH key:

- name: copy file via ssh key
  uses: appleboy/[email protected]
  with:
    host: ${{ secrets.HOST }}
    username: ${{ secrets.USERNAME }}
    port: ${{ secrets.PORT }}
    key: ${{ secrets.KEY }}
    source: "tests/a.txt,tests/b.txt"
    target: "test"

Example configuration for ignore list:

- name: copy file via ssh key
  uses: appleboy/[email protected]
  with:
    host: ${{ secrets.HOST }}
    username: ${{ secrets.USERNAME }}
    port: ${{ secrets.PORT }}
    key: ${{ secrets.KEY }}
    source: "tests/*.txt,!tests/a.txt"
    target: "test"

Example configuration for multiple servers:

  uses: appleboy/[email protected]
  with:
-   host: "example.com"
+   host: "foo.com,bar.com"
    username: foo
    password: bar
    port: 22
    source: "tests/a.txt,tests/b.txt"
    target: "test"

Remove the specified number of leading path elements:

- name: remove the specified number of leading path elements
  uses: appleboy/[email protected]
  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:

foobar
  └── tests
    ├── a.txt
    └── b.txt

New target structure:

foobar
  ├── a.txt
  └── b.txt

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.

  - name: ssh key with passphrase
    uses: appleboy/[email protected]
    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"

We use cookies. If you continue to browse the site, you agree to the use of cookies. For more information on our use of cookies please see our Privacy Policy.