tmshkr/ngrok-ssh
SSH into your GitHub Actions runner with ngrok.
View on GitHubTrust Signals
- Scorecard Score
- not yet scored
- Maintenance Recency
- Stale
- License
- None
Inputs
| name | description | required | default |
|---|---|---|---|
| BASH_PROFILE | Path to a text file to append to the host's .bash_profile. | no | — |
| NGROK_AUTHTOKEN | Your ngrok auth token, required for TCP tunnels. | yes | — |
| NGROK_CONFIG_FILE | Path to your custom ngrok config file, which will be merged with the default ngrok-ssh config file. See https://ngrok.com/docs/agent/config/#config-file-merging for more information. | no | — |
| SSH_PORT | SSH port to use with ngrok. | no | 2222 |
| SSH_CLIENT_PUBLIC_KEY | Public key of an SSH client to add to the authorized_keys file. | no | — |
| SSH_HOST_PRIVATE_KEY | Private key to use for the SSH host. | no | — |
| SSH_HOST_PUBLIC_KEY | Public key to use for the SSH host. | no | — |
| USE_GITHUB_ACTOR_KEY | Whether to add the GITHUB_ACTOR's public keys to the authorized_keys file. | no | true |
| WAIT_FOR_CONNECTION | Whether to wait for an SSH connection before allowing the workflow run to proceed. | no | false |
Outputs
| name | description |
|---|---|
| NGROK_TUNNELS | JSON representation of provisioned ngrok tunnels from the /api/tunnels endpoint, including any additional configured tunnels. |
| SSH_HOSTNAME | The hostname of the SSH server. |
| SSH_HOST_PUBLIC_KEY | The public key of the SSH host. |
| SSH_PORT | The public port of the SSH server. |
| SSH_USER | The username of the SSH user. |