Quick Start

Fresh

Get ngrok running on Windows in under 5 minutes.

Step 1: Install ngrok

Install from the Windows App Store or download directly from download.ngrok.com.

Verify installation:

bash

ngrok help

Step 2: Connect Your Account

bash

ngrok config add-authtoken YOUR_TOKEN

Get your token from the dashboard.

Step 3: Start Your App

Start any local service. Example Node.js server on port 8080:

const http = require('http');
const server = http.createServer((req, res) => {
    res.writeHead(200, { 'Content-Type': 'text/html' });
    res.end('<html><body><h1>Hello from ngrok!</h1></body></html>');
});
server.listen(8080, () => console.log('Serving at http://localhost:8080'));

Step 4: Expose It

bash

ngrok http 8080

ngrok prints a console UI with your public HTTPS URL. Open it in your browser.

Step 5: Secure It (Optional)

Edit your config file to add Google OAuth:

bash

ngrok config edit

Add below your authtoken:

yaml

endpoints:
  - name: my-app
    url: YOUR_DOMAIN
    traffic_policy:
      on_http_request:
        - actions:
          - type: oauth
            config:
              provider: google
    upstream:
      url: 8080
      protocol: http1

Start the named endpoint:

bash

ngrok start my-app

What's Next?

Quick Start ​

Step 1: Install ngrok ​

Step 2: Connect Your Account ​

Step 3: Start Your App ​

Step 4: Expose It ​

Step 5: Secure It (Optional) ​

Quick Start

Step 1: Install ngrok

Step 2: Connect Your Account

Step 3: Start Your App

Step 4: Expose It

Step 5: Secure It (Optional)