{"_id":"@achingbrain/ngrok","_rev":"4-bcd7632e398c6556f2b756c97d6f58ba","name":"@achingbrain/ngrok","description":"node wrapper for ngrok","dist-tags":{"latest":"0.2.2"},"versions":{"0.2.1":{"name":"@achingbrain/ngrok","version":"0.2.1","description":"node wrapper for ngrok","main":"index.js","scripts":{"preinstall":"npm install decompress-zip && node ./postinstall.js","test":"node ./node_modules/mocha/bin/_mocha","postupdate":"node ./postinstall.js"},"repository":{"type":"git","url":"git://github.com/bubenshchykov/ngrok.git"},"keywords":["ngrok","localhost","tunneling","localtunnel","webhook"],"author":{"name":"bubenshchykov"},"license":"BSD-2-Clause","bugs":{"url":"https://github.com/bubenshchykov/ngrok/issues"},"devDependencies":{"mocha":"~1.14.0","chai":"~1.8.1"},"dependencies":{"async":"^0.9.0","lock":"^0.1.2","request":"^2.55.0"},"bin":{"ngrok":"./bin/ngrok"},"gitHead":"06fc08e9be396e40eb281d09c273324fd1ff8a3f","homepage":"https://github.com/bubenshchykov/ngrok#readme","_id":"@achingbrain/ngrok@0.2.1","_shasum":"a03697fd77710c2d849171ab1d2b7d01e4f81f51","_from":".","_npmVersion":"2.11.3","_nodeVersion":"0.12.7","_npmUser":{"name":"achingbrain","email":"alex@achingbrain.net"},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"}],"dist":{"shasum":"a03697fd77710c2d849171ab1d2b7d01e4f81f51","tarball":"https://registry.npmjs.org/@achingbrain/ngrok/-/ngrok-0.2.1.tgz","integrity":"sha512-hvRrl3lSjVqvkO1UUjQplEzUcD0V5h+P/awSfCFyq1XXFdahHZm+gatghGHY1/zoL+5H9PE1yKSf8Yf/DSv3wA==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDFx64XJ56EvbCjwW5ysk+k9vfTen9gxWpCm+LsmhuRzAIhAICuQ7f6mrTEw/4wUc1JpcZcRc9s1s5ktfmMwKEwd5oH"}]}},"0.2.2":{"name":"@achingbrain/ngrok","version":"0.2.2","description":"node wrapper for ngrok","main":"index.js","scripts":{"postinstall":"node ./install-ngrok.js","test":"node ./node_modules/mocha/bin/_mocha","postupdate":"node ./install-ngrok.js"},"repository":{"type":"git","url":"git://github.com/bubenshchykov/ngrok.git"},"keywords":["ngrok","localhost","tunneling","localtunnel","webhook"],"author":{"name":"bubenshchykov"},"license":"BSD-2-Clause","bugs":{"url":"https://github.com/bubenshchykov/ngrok/issues"},"devDependencies":{"mocha":"~1.14.0","chai":"~1.8.1"},"dependencies":{"async":"^0.9.0","decompress-zip":"^0.1.0","lock":"^0.1.2","request":"^2.55.0"},"bin":{"ngrok":"./bin/ngrok"},"gitHead":"f497e16747975580b1f0b8807344bf07154b2985","homepage":"https://github.com/bubenshchykov/ngrok#readme","_id":"@achingbrain/ngrok@0.2.2","_shasum":"0c04d1914bf3b0ffb32d8891d51fabc48e0627f7","_from":".","_npmVersion":"2.11.3","_nodeVersion":"0.12.7","_npmUser":{"name":"achingbrain","email":"alex@achingbrain.net"},"maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"}],"dist":{"shasum":"0c04d1914bf3b0ffb32d8891d51fabc48e0627f7","tarball":"https://registry.npmjs.org/@achingbrain/ngrok/-/ngrok-0.2.2.tgz","integrity":"sha512-WFT/0MZG2pMkkUlO61eEYLXk31+OqMmE8SBSfA2xJwlM0XtyImW7wZJvrmX5+n9ivzGWkx7mFo2nd5Wp/2Ngaw==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIHEpaTwAxi2CebagkvNuOGJKs6cjOW0DMoe13c+HJ4WBAiAbTP6IFNZMff7Fx4KbxUcwSFamLuOEleixr1KwI6QfMA=="}]}}},"readme":"ngrok [![Build Status](https://travis-ci.org/bubenshchykov/ngrok.png?branch=master)](https://travis-ci.org/bubenshchykov/ngrok)\n=====\n\n![alt ngrok.com](https://ngrok.com/static/img/overview.png)\n\nNgrok exposes your localhost to the web. https://ngrok.com/\n\nusage\n===\n\n[![NPM](https://nodei.co/npm/ngrok.png?global=true&&downloads=true&downloadRank=true&stars=true)](https://nodei.co/npm/ngrok/)\n\nIt will download the ngrok 2.0 binary for your platform and put it into the bin folder. You can also install ngrok globally and use it directly from bash\n```shell\n$ npm install ngrok -g\n$ ngrok http 8080\n```\n\n## connect\n```javascript\nvar ngrok = require('ngrok');\n\nngrok.connect(function (err, url) {}); // https://757c1652.ngrok.io -> http://localhost:80\nngrok.connect(9090, function (err, url) {}); // https://757c1652.ngrok.io -> http://localhost:9090\nngrok.connect({proto: 'tcp', addr: 22}, function (err, url) {}); // tcp://0.tcp.ngrok.io:48590\nngrok.connect(opts, function(err, url) {});\n```\nFirst connect spawns the ngrok process so each next tunnel is created much faster.\n\n## options\n```javascript\nngrok.connect({\n\tproto: 'http', // http|tcp|tls\n\taddr: 8080, // port or network address\n\tauth: 'user:pwd', // http basic authentication for tunnel\n\tsubdomain: 'alex', // reserved tunnel name https://alex.ngrok.io,\n\tauthtoken: '12345' // your authtoken from ngrok.com\n}, function (err, url) {});\n```\n\nOther options: `name, inspect, host_header, bind_tls, hostname, crt, key, client_cas, remote_addr` - read [here](https://ngrok.com/docs)\n\n## disconnect\nThe ngrok and all tunnels will be killed when node process is done. To stop the tunnels use\n```javascript\nngrok.disconnect(url); // stops one\nngrok.disconnect(); // stops all\nngrok.kill(); // kills ngrok process\n```\n\n## authtoken\nMany advanced features of the ngrok.com service require that you sign up for an account and use authtoken. The authtoken you specify is not the same as the one you used for ngrok 1.0 - module versions prior to 0.2. Your 2.0 ngrok authtoken is available on your ngrok 2.0 dashboard.\n\nYou can pass it as option with each `connect` or set it once for further tunnels\n```javascript```\nngrok.authtoken(token, function(err, token) {});\n```\n\n## emitter\nAlso you can use ngrok as an event emitter, it fires \"connect\", \"disconnect\" and \"error\" events\n```javascript\nngrok.once('connect', function (url) {};\nngrok.connect(port);\n```\n\n## configs\nYou can use ngrok's [configurations files](https://ngrok.com/docs#config), then just pass `name` option when making a tunnel\n```\nOS X\t/Users/example/.ngrok2/ngrok.yml\nLinux\t/home/example/.ngrok2/ngrok.yml\nWindows\tC:\\Users\\example\\.ngrok2\\ngrok.yml\n```\n\n## inspector\nWhen tunnel is established you can use the ngrok interface http://127.0.0.1:4040 to inspect the webhooks done via ngrok.\n","maintainers":[{"name":"achingbrain","email":"alex@achingbrain.net"}],"time":{"modified":"2022-06-12T14:16:02.510Z","created":"2015-08-11T15:21:24.552Z","0.2.1":"2015-08-11T15:21:24.552Z","0.2.2":"2015-08-12T07:35:29.632Z"},"homepage":"https://github.com/bubenshchykov/ngrok#readme","keywords":["ngrok","localhost","tunneling","localtunnel","webhook"],"repository":{"type":"git","url":"git://github.com/bubenshchykov/ngrok.git"},"author":{"name":"bubenshchykov"},"bugs":{"url":"https://github.com/bubenshchykov/ngrok/issues"},"license":"BSD-2-Clause","readmeFilename":"README.md"}