Skip to content
terminal

GitHub Action

Install SSH Key

v1.3.0 Latest version
Use latest version
terminal

Install SSH Key

Install SSH key to ~/.ssh

Installation

Copy and paste the following snippet into your .yml file.

- name: Install SSH Key
  uses: shimataro/ssh-key-action@v1.3.0
Learn more about this action in shimataro/ssh-key-action
Choose a version

Install SSH key

Build Connection test Release License

This action installs SSH key into ~/.ssh.

Useful for SCP, SFTP, and rsync over SSH in deployment script.

Usage

Add your SSH key to your product secrets by clicking Settings - Secrets - Add a new secret beforehand.

runs-on: ubuntu-latest
steps:
- name: Install SSH key
  uses: shimataro/ssh-key-action@v1
  with:
    private-key: ${{ secrets.SSH_KEY }}
    public-key: ${{ secrets.SSH_KEY_PUBLIC }}
    name: id_rsa # optional
    known-hosts: ${{ secrets.KNOWN_HOSTS }} # optional
- name: Install packages
  run: apt install openssh-client rsync
- name: rsync over ssh
  run: rsync ./foo/ user@remote:bar/

See Workflow syntax for GitHub Actions for details.

License

The scripts and documentation in this project are released under the MIT License

Changelog

See CHANGELOG.md.

You can’t perform that action at this time.