{"id":13425020,"url":"https://github.com/jerson/pgrok","last_synced_at":"2025-03-15T19:32:29.916Z","repository":{"id":39626771,"uuid":"199860897","full_name":"jerson/pgrok","owner":"jerson","description":"Free Introspected tunnels to localhost, like ngrok but free and unlimited","archived":true,"fork":true,"pushed_at":"2022-05-30T14:53:46.000Z","size":12347,"stargazers_count":283,"open_issues_count":0,"forks_count":55,"subscribers_count":10,"default_branch":"master","last_synced_at":"2024-08-01T00:43:12.258Z","etag":null,"topics":["docker","golang","linux","macos","ngrok","pgrok","proxy","windows"],"latest_commit_sha":null,"homepage":"https://hub.docker.com/r/jerson/pgrok","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":"inconshreveable/ngrok","license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jerson.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null},"funding":{"patreon":"jerson","open_collective":null,"ko_fi":null,"tidelift":null,"community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null,"custom":"https://paypal.me/gpardogamez"}},"created_at":"2019-07-31T13:23:51.000Z","updated_at":"2024-06-05T08:09:20.000Z","dependencies_parsed_at":null,"dependency_job_id":null,"html_url":"https://github.com/jerson/pgrok","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jerson%2Fpgrok","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jerson%2Fpgrok/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jerson%2Fpgrok/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jerson%2Fpgrok/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jerson","download_url":"https://codeload.github.com/jerson/pgrok/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":221609553,"owners_count":16851387,"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":["docker","golang","linux","macos","ngrok","pgrok","proxy","windows"],"created_at":"2024-07-31T00:01:02.453Z","updated_at":"2024-10-27T00:30:18.176Z","avatar_url":"https://github.com/jerson.png","language":"Go","funding_links":["https://patreon.com/jerson","https://paypal.me/gpardogamez"],"categories":["Go","golang"],"sub_categories":[],"readme":"# pgrok - Introspected tunnels to localhost\n\n### ”I want to expose a local server behind a NAT or firewall to the internet.”\n\n**ejemplo.me** service is shuting down, please take a look, https://github.com/jerson/pgrok/issues/20\n\n# Install client\n\nInstall supports **Linux** and **MacOS** with **homebrew**\n\n```bash\nbrew install jerson/tap/pgrok\n```\n# Usage\n\n```bash\npgrok -subdomain=customsubdomain 3000\n```\nsample output\n\n```bash\npgrok                                                           (Ctrl+C to quit)\n                                                                                \nTunnel Status                 online                                            \nVersion                       3.0/3.0                                           \nForwarding                    http://customsubdomain.ejemplo.me -\u003e 127.0.0.1:3000            \nForwarding                    https://customsubdomain.ejemplo.me -\u003e 127.0.0.1:3000           \nWeb Interface                 http://127.0.0.1:4040                             \n# Conn                        0                                                 \nAvg Conn Time                 0.00ms \n```\n\n# Downloads\n\njust download in [Release section](https://github.com/jerson/pgrok/releases)\n\n# Install server\n\nInstall supports **Linux** and **MacOS** with **homebrew**\n\n```bash\nbrew install jerson/tap/pgrokd\n```\n\nor you can just download it from download section\n\n# Install server with Docker\n\npgrok and pgrokd available in [Docker Hub](https://hub.docker.com/r/jerson/pgrok)\n\nSample server in docker-compose\n\n```yaml\nversion: \"3.7\"\n\nservices:\n  pgrokd:\n    image: jerson/pgrok\n    entrypoint: pgrokd\n    command: -domain ejemplo.me -httpAddr=:80 -httpsAddr=:443 -tunnelAddr=:4443 -tlsCrt=/certs/tls.crt -tlsKey=/certs/tls.key\n    volumes:\n      - /home/certs:/certs\n    ports:\n      - 80:80\n      - 443:443\n      - 4443:4443\n```\n\n## What is pgrok?\n\npgrok is a reverse proxy that creates a secure tunnel from a public endpoint to a locally running web service.\npgrok captures and analyzes all traffic over the tunnel for later inspection and replay.\n\n## What can I do with pgrok?\n\n- Expose any http service behind a NAT or firewall to the internet on a subdomain of ejemplo.me\n- Expose any tcp service behind a NAT or firewall to the internet on a random port of ejemplo.me\n- Inspect all http requests/responses that are transmitted over the tunnel\n- Replay any request that was transmitted over the tunnel\n\n## What is pgrok useful for?\n\n- Temporarily sharing a website that is only running on your development machine\n- Demoing an app at a hackathon without deploying\n- Developing any services which consume webhooks (HTTP callbacks) by allowing you to replay those requests\n- Debugging and understanding any web service by inspecting the HTTP traffic\n- Running networked services on machines that are firewalled off from the internet\n\n## Developing on pgrok\n\n[pgrok developer's guide](docs/DEVELOPMENT.md)\n\n## Disclaimer\n\npgrok is a fork of ngrok\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjerson%2Fpgrok","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjerson%2Fpgrok","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjerson%2Fpgrok/lists"}