@expo/ngrok

    2.5.0 • Public • Published

    ngrok Build Status

    alt ngrok.com

    Ngrok exposes your localhost to the web. https://ngrok.com/

    usage

    NPM

    var ngrok = require('ngrok');
    ngrok.connect(function (err, url) {});
    
    or
    
    npm install ngrok -g
    ngrok http 8080
    

    authtoken

    You can create basic http-https-tcp tunnel without authtoken. For custom subdomains and more you should obtain authtoken by signing up at ngrok.com. Once you set it, it's stored in ngrok config and used for all tunnels. Few ways:

    ngrok.authtoken(token, function(err, token) {});
    ngrok.connect({authtoken: token, ...}, function (err, url) {});
    ngrok authtoken <token>
    

    connect

    var ngrok = require('ngrok');
    
    ngrok.connect(function (err, url) {}); // https://757c1652.ngrok.io -> http://localhost:80
    ngrok.connect(9090, function (err, url) {}); // https://757c1652.ngrok.io -> http://localhost:9090
    ngrok.connect({proto: 'tcp', addr: 22}, function (err, url) {}); // tcp://0.tcp.ngrok.io:48590
    ngrok.connect(opts, function(err, url) {});

    options

    ngrok.connect({
    	proto: 'http', // http|tcp|tls
    	addr: 8080, // port or network address
    	auth: 'user:pwd', // http basic authentication for tunnel
    	subdomain: 'alex', // reserved tunnel name https://alex.ngrok.io
    	authtoken: '12345', // your authtoken from ngrok.com
    	region: 'us' // one of ngrok regions (us, eu, au, ap), defaults to us
    }, function (err, url) {});

    Other options: name, inspect, host_header, bind_tls, hostname, crt, key, client_cas, remote_addr - read here

    Note on regions: region used in first tunnel will be used for all next tunnels too.

    disconnect

    The ngrok and all tunnels will be killed when node process is done. To stop the tunnels use

    ngrok.disconnect(url); // stops one
    ngrok.disconnect(); // stops all
    ngrok.kill(); // kills ngrok process

    Note on http tunnels: by default bind_tls is true, so whenever you use http proto two tunnels are created - http and https. If you disconnect https tunnel, http tunnel remains open. You might want to close them both by passing http-version url, or simply by disconnecting all in one go ngrok.disconnect().

    emitter

    Also you can use ngrok as an event emitter, it fires "connect", "disconnect" and "error" events

    ngrok.once('connect', function (url) {};
    ngrok.connect(port);

    configs

    You can use ngrok's configurations files, then just pass name option when making a tunnel. Configuration files allow to specify more options, eg ngrok region you want to use.

    OS X	/Users/example/.ngrok2/ngrok.yml
    Linux	/home/example/.ngrok2/ngrok.yml
    Windows	C:\Users\example\.ngrok2\ngrok.yml
    

    inspector

    When tunnel is established you can use the ngrok interface http://127.0.0.1:4040 to inspect the webhooks done via ngrok.

    process

    To get a handle to the spawned ngrok process use

    ngrok.process(); // returns ChildProcess

    how it works

    npm install downloads ngrok binaries for you platform and puts them into bin folder. You can host binaries yourself and set NGROK_CDN_URL env var before installing ngrok. Or you can force specific arch by setting NGROK_ARCH, eg NGROK_ARCH=freebsdia32

    First time you create tunnel ngrok process is spawned and runs until you disconnect or when parent process killed. All further tunnels are created or stopped by using internal ngrok api which usually runs on http://127.0.0.1:4040

    contributors

    Please run git update-index --assume-unchanged bin/ngrok to not override ngrok stub in your pr. Unfortunately it can't be gitignored.

    Install

    npm i @expo/ngrok

    DownloadsWeekly Downloads

    16,948

    Version

    2.5.0

    License

    BSD-2-Clause

    Unpacked Size

    10.9 kB

    Total Files

    4

    Last publish

    Collaborators

    • christopherwalter
    • kbrandwijk
    • kgc00
    • fiber-god
    • ide
    • brentvatne
    • ccheever
    • evanbacon
    • quinlanj
    • esamelson
    • expoadmin
    • tsapeta
    • dsokal
    • tcdavis
    • exponent
    • wschurman
    • bbarthec
    • wkozyra
    • bycedric
    • lukmccall
    • jonsamp
    • princefleaswallow
    • andyboythekid
    • kudochien