Skip to content

Latest commit

 

History

History
24 lines (17 loc) · 1.12 KB

README.md

File metadata and controls

24 lines (17 loc) · 1.12 KB
Raw

SSH Server Action

This action starts an SSH server and makes it available using ngrok. A free ngrok account will allow you to run a single SSH tunnel.

When the server is ready, you will see a message in your workflow output similar to the following:

To SSH to this runner: `ssh -i /path/to/private/key -p 11111 [email protected]`

Due to an issue with workflow output, you will only see the message if you were already viewing the workflow logs when the message was printed (or when the workflow finishes, but the server will no longer be running). In that case you can find the tunnel address on ngrok's status page.

Usage

See action.yml for a description of the options. A sample workflow showing how to run this action if a step fails can be found here.

steps:
- uses: mdelillo/ssh-server-action@v1
  with:
    ngrok-authtoken: "<your-ngrok-authtoken>"
    ssh-public-key: "ssh-rsa AAAAB3NzaC1yc2E..."