Skip to content
You're viewing an older version of this GitHub Action. Do you want to see the latest version instead?
terminal

GitHub Action

Debug via SSH

v1.0

Debug via SSH

terminal

Debug via SSH

SSH to a GitHub Actions runner using ngrok

Installation

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

 
              
- name: Debug via SSH

              
  uses: luchihoratiu/debug-via-ssh@v1.0
Learn more about this action in luchihoratiu/debug-via-ssh

Choose a version

debug-via-ssh

This GitHub Action allows you to connect to a GitHub Actions runner via SSH for interactive debugging using ngrok.

Features

It works with Ubuntu, macOS and Windows runners.

Quick usage

- name: Start SSH session
  uses: luchihoratiu/debug-via-ssh@main
  with:
    NGROK_AUTH_TOKEN: ${{ secrets.NGROK_AUTH_TOKEN }}
    SSH_PASS: ${{ secrets.SSH_PASS }}

Settings

Mandatory

  • NGROK_AUTH_TOKEN - The authorization token received from ngrok. See FAQ section for more info.
  • SSH_PASS - The password used for starting a SSH session. For Windows runners, this password must respect some minimum complexity requirements.

Optional

  • NGROK_REGION - The region where the ngrok client will connect to host its tunnels. Defaults to us.
  • NGROK_TIMEOUT - The max amount of time ngrok will host its tunnel. Defaults to 21500 (value is in seconds).

FAQ

How to get ngrok auth token?

  1. Go to https://ngrok.com/
  2. Hit Sign up in the top right corner
  3. Login via GitHub/Google or Sign up for a standalone account
  4. From the given dashboard, you can now get your ngrok auth token

What regions are avaliable for ngrok?

See https://ngrok.com/docs for latest information.

  • us - United States
  • eu - Europe
  • ap - Asia/Pacific
  • au - Australia
  • sa - South America
  • jp - Japan
  • in - India