setup-ssh-authentication-action's Introduction

Setup SSH authentication

This action installs your private key and related files in ~/.ssh to allow an SSH key-based authentication with a remote server.

Usage

- name: Setup SSH key
  uses: benoitchantre/[email protected]
  with:
    # Private key for connecting to remote hosts.
    # Required.
    private-key: ${{ secrets.PRIVATE_KEY }}

    # Filename of the private key.
    # Optional. Default to `id_rsa`
    private-key-name: id_rsa

    # The SSH configuration. Content of `~/.ssh/config` file.
    # Optional.
    ssh-config: ${{ secrets.SSH_CONFIG }}

    # Content of `~/.ssh/known_hosts` file. The public SSH keys for a
    # host may be obtained using the utility `ssh-keyscan`.
    # Required.
    known-hosts: ${{ secrets.KNOWN_HOSTS }}

You can use run this action multiple times to install more than one key as long as you use different key names.

License

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

setup-ssh-authentication-action's People

Contributors

Stargazers

Watchers

setup-ssh-authentication-action's Issues

Readme contains wrong version tag

In your readme you use

uses: benoitchantre/setup-ssh-authentication-action@v1

However, there is no tag v1 but only 1.0.0. (also note the missing v)

So the correct line is

uses: benoitchantre/[email protected]

Mention PEM encoding

Could you mention "PEM encoding" at private-key in README?
I may be theoretic.

Doesn't work inside a docker container running as root

Inside a docker container running as root, $HOME=/github/home, meaning the files get written to /github/home/.ssh. However, ssh looks for the ssh key/config under /root/.ssh.

For reference, shimataro/ssh-key-action had this special case:

	if(home === "/github/home")
	{
		// Docker container
		return "/root";
	}

Use @v3 tag to bring it in line with github actions nodejs/version schema

Might sound very stupid, but can this be retagged as v3? This will be in line with the v3 schema github base actions are providing, currently the action works only if you launch it as benoitchantre/[email protected]

So I know all v3 are running on nodejs v16 :)

Recommend Projects

benoitchantre / setup-ssh-authentication-action Goto Github PK

setup-ssh-authentication-action's Introduction

Setup SSH authentication

Usage

License

setup-ssh-authentication-action's People

Contributors

Stargazers

Watchers

Forkers

setup-ssh-authentication-action's Issues

Readme contains wrong version tag

Mention PEM encoding

Doesn't work inside a docker container running as root

Use @v3 tag to bring it in line with github actions nodejs/version schema

Recommend Projects

React

Vue.js

Typescript

TensorFlow

Django

Laravel

D3

Recommend Topics

javascript

web

server

Machine learning

Visualization

Game

Recommend Org

Facebook

Microsoft

Google

Alibaba

D3

Tencent