Skip to main content

Download & Install

The fastest way to put anything on the internet.

FreeBSDAgent

1

Install the ngrok agent

Download a standalone executable with zero run time dependencies.

Download

In a terminal, extract ngrok:

sudo tar -xvzf ~/Downloads/ngrok-v3-stable-freebsd-amd64.tgz -C /usr/local/bin
2

Add your authtoken

ngrok config add-authtoken "<YOUR_AUTHTOKEN>"

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

3

Start an endpoint

ngrok http 80

80 is an example port. Use your app’s actual port. View docs for more info.

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

You’re all set. What’s next?

Create a policy.yaml file and run this command:

ngrok http 80 --traffic-policy-file policy.yaml
contents of policy.yaml
1on_http_request:2  # redirect users to Google to log in3  - actions:4    - type: oauth5      config:6        provider: google7 8  # allow logins *only* from acme.com9  - expressions:10    - "!actions.ngrok.oauth.identity.email.endsWith('@acme.com')"11    actions:12    - type: deny

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.

Configure your agent

Configure settings like multiple endpoints, load balancing, and traffic transformation with Traffic Policy.

Bring your own domain

Paid feature

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

ngrok http 8080 --url https://app.acme.com