Skip to main content

Download & Install

The fastest way to put anything on the internet.

Node.jsSDK

1

Get started with Node.js

Clone the ngrok Node.js SDK example and install dependencies:

git clone git@github.com:ngrok/node-sdk-example.git && cd node-sdk-example
npm install

Install the ngrok Node.js SDK:

npm install @ngrok/ngrok

Add ngrok to your app:

index.js

1const ngrok = require("@ngrok/ngrok");2 3async function forwardToApp() {4	const forwarder = await ngrok.forward({5		addr: "localhost:8085",6		authtoken_from_env: true,7	});8	console.log(`Available at: ${forwarder.url()}`);9}10 11forwardToApp();
2

Run your app

NGROK_AUTHTOKEN="<YOUR_AUTHTOKEN>" node index.js

Don’t have an authtoken? for a free account.

Open your ngrok URL in a browser to see it working!

Watch

The JavaScript SDK, end to end

You’re all set. What’s next?

1const tp = `2on_http_request:3	# redirect users to Google to log in4	- actions:5		- type: oauth6			config:7				provider: google8 9	# allow logins *only* from acme.com10	- expressions:11		- "!actions.ngrok.oauth.identity.email.endsWith('@acme.com')"12		actions:13		- type: deny14`;15 16const forwarder = await ngrok.forward({ addr: 8080, traffic_policy: tp });
1const tp = `2on_http_request:3	# verify webhook signatures from your provider4	- actions:5		- type: verify-webhook6			config:7				provider: github8				# access your signing key from a secure ngrok vault9				# no cleartext secrets in your policy, friend10				secret: ${secrets.get('webhook-vault', 'github-secret')}11`;12 13const forwarder = await ngrok.forward({ addr: 8080, traffic_policy: tp });
1const tp = `2on_http_request:3	# redirect users to your OpenID provider to log in4	- actions:5		- type: openid-connect6			config:7				issuer_url: https://accounts.google.com8				# access your OIDC details from a secure ngrok vault9				client_id: ${secrets.get('auth-vault', 'oidc-client-id')}10				client_secret: ${secrets.get('auth-vault', 'oidc-client-secret')}11				scopes:12					- openid13					- email14`;15 16const forwarder = await ngrok.forward({ addr: 8080, traffic_policy: tp });
1const tp = `2on_http_request:3	- actions:4		- type: basic-auth5			config:6				credentials:7					# add up to 10 username:password pairs, all stored safely in a vault8					- user01:${secrets.get('basic-auth-vault', 'password01')}9					- user02:${secrets.get('basic-auth-vault', 'password02')}10`;11 12const forwarder = await ngrok.forward({ addr: 8080, traffic_policy: tp });

Inspect every detail of your traffic

Watch the flow in real time, then dig into the headers, body, latency, response, and more for every request.

Peruse the NodeJS SDK quickstart

Follow along to embed ngrok into your app and use Traffic Policy for auth and traffic transformation.

Bring your own domain

Paid feature

Create a DNS CNAME record to use your own domain name for your endpoint URL.

1async function connectNgrok() {2	const forwarder = await ngrok.forward({3		addr: 8085,4		authtoken_from_env: true,5		domain: "app.acme.com",6	});7}

Add load balancing

Endpoint Pooling lets you automatically distribute traffic among any number of replicas of your app.

1const ngrok = require("@ngrok/ngrok");2 3async function forwardToApp() {4	const session = await new ngrok.SessionBuilder().authtokenFromEnv().connect();5	const listener = await session6		.httpEndpoint()7		.domain("app.acme.com")8		// Endpoint pooling is currently only supported through the builder API, not ngrok.forward().9		.poolingEnabled(true)10		.listenAndForward("http://localhost:8085");11	console.log(`Available at: ${listener.url()}`);12}13 14forwardToApp();