NG
SOFTWARE

ngrok

ngrok creates temporary or managed public endpoints for local services through tunnels, inspection and access policies. This page covers endpoint scope, authentication, local exposure, debugging and cleanup.

Version 3.39.10WindowsmacOSLinuxFreeBSDDocker多种 CPU 架构Client license and service terms apply

What ngrok provides

ngrok connects a local service to a public or managed endpoint for development, demonstrations and controlled integrations. The tunnel changes who can reach the service, so authentication, request logging, data handling and shutdown are part of the setup rather than optional extras.

Endpoint scope and cleanup

Start with a harmless test service, expose only the required port and add an access policy before sending real data. Inspect requests for unexpected headers or payloads, use a short-lived endpoint when possible and stop the tunnel when the test ends.

Maintenance note

This page reviews ngrok for local service tunnels, request inspection, authentication and temporary public exposure. Content review date: 2026-08-23.

SAVE TO CLOUD

Save to your cloud drive

Open the cloud drive to get the file directly, or save it for convenient access on another device.

Links checked 2026-08-06
Save first, access when you need itOn desktop, scan with the matching cloud-drive app. On mobile, tap the save button.
GUIDE

ngrok local service tunnel guide

Run a harmless local service, expose one port, protect the endpoint and inspect a test request before connecting any real account or private data.

Before you start

  • Prepare a local test service with no sensitive data and a documented port.
  • Decide who should access the endpoint and how the tunnel will be closed.
  • Keep credentials and private request payloads out of shared inspection logs.
01

Installation steps

  1. 01

    Install and authenticate the client

    Install ngrok, configure the client credential through the supported local mechanism and verify that the configuration file has restricted access.

  2. 02

    Start one protected endpoint

    Tunnel only the test port, add authentication or an access policy and confirm that an unauthenticated request is rejected as expected.

  3. 03

    Inspect and close the session

    Send a harmless request, review the inspection data, stop the tunnel and confirm that the public endpoint no longer reaches the local service.

02

Quick start

  1. 01

    Keep endpoint names descriptive

    Use a project and purpose label without including customer identifiers, credentials or internal host names.

  2. 02

    Test webhook behavior

    Validate method, headers, retries and signature checks with a fixture payload before pointing a real integration at the endpoint.

  3. 03

    Rotate short-lived access

    Remove temporary policies and rotate credentials when a demo or integration test is complete.

Usage tips

  • A tunnel is public reachability, not a substitute for application authentication or input validation.
  • Avoid sending production secrets, personal data or long-lived tokens through a temporary endpoint.
  • Review and delete inspection records that contain sensitive payloads according to the retention policy.
Troubleshooting and uninstall

Why does the local service return a connection error?

Check that the service is listening on the expected interface and port, that the tunnel targets the same port and that local firewall rules permit the client connection.

Why does a webhook work once and then fail?

Check endpoint lifetime, access policy, signature validation, retries and application logs, then reproduce with a sanitized fixture before restoring the integration.

  1. Stop endpoints and revoke temporary accessClose running tunnels, remove test policies and rotate any credential that was used for a shared demonstration.
  2. Remove the clientUninstall ngrok through the operating system and remove local configuration or inspection data only after confirming that no required endpoint remains.
FAQ

Frequently asked questions

Is an ngrok endpoint private by default?

Treat a running endpoint as reachable by its intended public network. Add application authentication and an endpoint access policy before testing anything sensitive.

Can ngrok be used for production traffic?

That depends on the service plan, architecture and operational controls. Evaluate reliability, data handling, authentication and observability before using it beyond a controlled test.

Does the download require an extraction code?

The Quark entry does not require one; the four-character code for the Baidu entry is shown beside its download entry.