{"id":24594766,"url":"https://github.com/luisboto/ngrok-tunnel-action","last_synced_at":"2025-06-16T13:09:48.788Z","repository":{"id":65158148,"uuid":"502571077","full_name":"LuisBoto/ngrok-tunnel-action","owner":"LuisBoto","description":"🧪 Github Action to tunnel traffic from a Github runner using Ngrok","archived":false,"fork":false,"pushed_at":"2022-06-14T09:45:16.000Z","size":32,"stargazers_count":10,"open_issues_count":1,"forks_count":8,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-05-21T20:50:48.643Z","etag":null,"topics":["github","github-action","github-actions-runner","ngrok","ngrok-action","ngrok-tunnel","tunnelling"],"latest_commit_sha":null,"homepage":"","language":null,"has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/LuisBoto.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-06-12T09:24:52.000Z","updated_at":"2025-04-02T14:47:36.000Z","dependencies_parsed_at":"2023-01-05T05:03:18.542Z","dependency_job_id":null,"html_url":"https://github.com/LuisBoto/ngrok-tunnel-action","commit_stats":null,"previous_names":[],"tags_count":14,"template":false,"template_full_name":null,"purl":"pkg:github/LuisBoto/ngrok-tunnel-action","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LuisBoto%2Fngrok-tunnel-action","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LuisBoto%2Fngrok-tunnel-action/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LuisBoto%2Fngrok-tunnel-action/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LuisBoto%2Fngrok-tunnel-action/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/LuisBoto","download_url":"https://codeload.github.com/LuisBoto/ngrok-tunnel-action/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/LuisBoto%2Fngrok-tunnel-action/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":260166294,"owners_count":22968632,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["github","github-action","github-actions-runner","ngrok","ngrok-action","ngrok-tunnel","tunnelling"],"created_at":"2025-01-24T11:45:10.409Z","updated_at":"2025-06-16T13:09:48.765Z","avatar_url":"https://github.com/LuisBoto.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# Ngrok tunnel Github Action\n\nThis action is based on [this repository](https://github.com/apogiatzis/ngrok-tunneling-action).\n\nThis is a Github Action that can be used in your Github Workflow to tunnel incoming/outgoing TCP or HTTP traffic in your workflow environment, achieving temporary deployment for testing or other purposes.\n\n## How to use\n\nThis action accepts the following parameters:\n\n| Name| Description | Required  | Default |\n| ------------- |-------------|-----|-----|\n| timeout | After this timeout the deployment will automatically shutdown the tunelling and therefore stop the action. (max is 6 hours) | No | 1h |\n| port | The port in localhost to forward traffic from/to  | Yes | - |\n| ngrok_authtoken | Your ngrok authtoken| Yes | - |\n| tunnel_type | Whether the tunnel type will be TCP or HTTP | Yes | tcp |\n| save_url_to_filename | If provided, save the deployed tunnel's URL to a file with the provided name, otherwise just print URL on console | No | - |\n\n\nHere is an example of using this action:\n\n```yaml\nname: CI\non: push\n\njobs:\n\n  deploy:\n    name: Docker container with Ngrok tunnel\n    runs-on: ubuntu-latest\n    needs: cancel\n\n    steps:\n    - name: Checkout\n      uses: actions/checkout@v2\n    \n    - name: Run container\n      run: docker-compose up -d \n    \n    - uses: luisboto/ngrok-tunnel-action@\u003cVERSION\u003e\n      with:\n        timeout: 1h\n        port: 8080\n        ngrok_authtoken: ${{ secrets.NGROK_AUTHTOKEN }}\n        tunnel_type: http\n        save_url_to_filename: tunnelURL.md\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fluisboto%2Fngrok-tunnel-action","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fluisboto%2Fngrok-tunnel-action","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fluisboto%2Fngrok-tunnel-action/lists"}