{"repo":"bubenshchykov/ngrok","free":true,"listed":false,"github":"https://github.com/bubenshchykov/ngrok","clone":"git clone https://github.com/bubenshchykov/ngrok.git","description":"Expose your localhost to the web. Node wrapper for ngrok.","language":"JavaScript","stars":2416,"topics":["ngrok","tunneling","tunnel","webhook","localhost"],"license":null,"category":"networking-infra","readme_excerpt":"ngrok This project is the Node.js wrapper for the ngrok client. Version 5 of this project uses ngrok client version 3. For ngrok client version 2, check out version 4. Usage Local install Global install Auth Token Connect Options Disconnect Config Updating config for ngrok version 3 Inspector API List tunnels Start tunnel Get tunnel details Stop tunnel List requests Replay request Delete all requests Request detail Proxy How it works ngrok binary update Using with nodemon Contributors Upgrading to version 5 Config Connect options Upgrading to version 4 TypeScript Usage Local install Install the package with npm: Then use ngrok.connect() to start ngrok and open a tunnel. This module uses node =10.19.0 with async/await. For a callback-based version use 2.3.0. Global install For global install on Linux, you might need to run sudo npm install --unsafe-perm -g ngrok due to the nature of npm postinstall script. Auth Token You can create basic http-https-tcp tunnel without an authtoken. For custom subdomains and more you should obtain an authtoken by signing up at ngrok.com. Once you set the authtoken, it is stored in ngrok config and used for all tunnels. You can set the authtoken directly: Or pass the authtoken to the connect method like so: Connect There are a number of ways to create a tunnel with ngrok using the connect method. By default, connect will open an HTTP tunnel to port 80 You can pass the port number to connect to specify that port: Or you can pass an object of optio","default_branch":null,"files":null,"tree":[],"storefront":"/r/bubenshchykov","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/bubenshchykov/ngrok/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}