https://github.com/luchihoratiu/debug-via-ssh

Here you can find a GitHub Action that allows you to connect to a GitHub Actions runner via SSH for interactive debugging using ngrok.
https://github.com/luchihoratiu/debug-via-ssh

github-actions github-runner macos-runners ngrok ssh ubuntu-runners windows-runners

Last synced: 1 day ago
JSON representation

Here you can find a GitHub Action that allows you to connect to a GitHub Actions runner via SSH for interactive debugging using ngrok.

• Host: GitHub
• URL: https://github.com/luchihoratiu/debug-via-ssh
• Owner: luchihoratiu
• License: gpl-3.0
• Created: 2020-10-02T06:10:04.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2024-01-12T13:45:01.000Z (10 months ago)
• Last Synced: 2024-04-14T07:11:48.963Z (7 months ago)
• Topics: github-actions, github-runner, macos-runners, ngrok, ssh, ubuntu-runners, windows-runners
• Homepage:
• Size: 28.3 KB
• Stars: 62
• Watchers: 5
• Forks: 134
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: COPYING

Awesome Lists containing this project

README

        
# 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

```yaml

- 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](https://docs.microsoft.com/en-us/windows/security/threat-protection/security-policy-settings/password-must-meet-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