Quick Start

This guide gets you from zero to a working tunnel in about 60 seconds. By the end, you'll have a public URL pointing to something running on your machine.

Prerequisites

1. Install Localport (takes ~30 seconds)

2. Have something running locally — a web app, API, file server, anything on a port

3. A tunnel token from the Localport dashboard

Don't have a local server handy? Start a quick one:

# Python (built-in on most systems)
python3 -m http.server 3000

# Node.js
npx serve -p 3000

Start your first tunnel

localport http 3000 --token YOUR_TOKEN

http is the protocol your service speaks, 3000 is the port it's listening on. Use tcp for game servers, databases, SSH, and any non-HTTP service. Full reference in the CLI docs.

Open the URL

Localport prints the public URL once the tunnel connects — copy it from the status panel into your browser, send it to a teammate, or paste it into a webhook setting. Your local app is now reachable over a valid HTTPS connection from any device, anywhere.

Stop the tunnel

Press Ctrl+C in the terminal. The public URL stops working immediately. There's no cleanup, no lingering processes.

Common flags

Flag	Short	What it does	Example
--token	-t	Tunnel authentication token	--token tok_abc
--local	-l	Local address (optional scheme prefix)	--local tcp://192.168.1.50:5432
--proto	—	Protocol: http, tcp, or tls	--proto tcp
--region	-r	Edge region: eu, us, ap	--region eu
--name	—	Client name (for mesh tunnels)	--name my-laptop

What to read next

Pick the guide that matches what you're building:

• HTTP Tunnels — Share a web app, test webhooks, demo to clients
• TCP Tunnels — Expose databases, game servers, SSH
• Mesh Tunnels — Connect a fleet of devices, each with its own URL
• Shared Tunnels — Broadcast webhooks to your whole team
• CLI — Every flag, option, and exit code
• Configuration — Multi-tunnel YAML config reference