Skip to content

LuisEnMarroquin/setup-ssh-action

Use this GitHub action with your project
Add this Action to an existing workflow or create a new one
View on Marketplace

Repository files navigation

Setup SSH - GitHub Action

Fail Fail Fail

This action sets up your SSH key on Windows, macOS and Ubuntu Virtual Environments

Example usage

Setup for GitHub

name: Deployment

on:
  push:
    branches:
    - main

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
    - uses: LuisEnMarroquin/setup-ssh-action@v2.0.0
      with:
        SSHKEY: ${{ secrets.SSH }} # ----- BEGIN RSA PRIVATE KEY----- ...
    - run: ssh -T git@github.com || true

Setup for your server

name: Deployment

on:
  push:
    branches:
    - main

jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
    - uses: LuisEnMarroquin/setup-ssh-action@v2.0.0
      with:
        ORIGIN: ${{ secrets.HOST }} # example.com || 8.8.8.8
        SSHKEY: ${{ secrets.SSH }} # ----- BEGIN RSA PRIVATE KEY----- ...
        NAME: production
        PORT: ${{ secrets.PORT }} # 3000
        USER: ${{ secrets.USER }} # admin
    - run: ssh production ls --help

Inputs

Key Value Information Required
ORIGIN Where to log in, can be a Domain or IP address, defaults to github.com No
SSHKEY Your SSH access key, it's better to store it on your repository secrets Yes
NAME How you can refer to the SSH key in the next commands, defaults to ORIGIN No
PORT The port that will be on the SSH config No
USER The user that will be on the SSH config No

Your repo secrets are at: https://github.com/<username>/<repository>/settings/secrets