Download & Install
The fastest way to put anything on the internet.
LinuxAgent
1
Install the ngrok agent
Install ngrok via Apt with the following command:
1curl -sSL https://ngrok-agent.s3.amazonaws.com/ngrok.asc \2 | sudo tee /etc/apt/trusted.gpg.d/ngrok.asc >/dev/null \3 && echo "deb https://ngrok-agent.s3.amazonaws.com bookworm main" \4 | sudo tee /etc/apt/sources.list.d/ngrok.list \5 && sudo apt update \6 && sudo apt install ngrok2
Add your authtoken
ngrok config add-authtoken <YOUR_AUTHTOKEN>Don’t have an authtoken? Sign up for a free account.
3
Start an endpoint
ngrok http 8080 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.yamlcontents 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: denyInspect 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.
