HTTP tunnels give your local server a public HTTPS URL that anyone can access. WebSocket connections are passed through automatically — no extra configuration needed.Documentation Index
Fetch the complete documentation index at: https://mintlify.com/outray-tunnel/outray/llms.txt
Use this file to discover all available pages before exploring further.
Basic usage
http subcommand and pass the port directly:
tunnel.outray.app. Use --subdomain or --domain to control this.
Flags
| Flag | Type | Description |
|---|---|---|
--subdomain <name> | string | Request a specific subdomain (e.g. my-app → my-app.tunnel.outray.app). |
--domain <domain> | string | Use a custom domain configured in your OutRay dashboard. |
--password <password> | string | Protect the tunnel with HTTP basic auth. Requires a paid plan. |
--org <slug> | string | Open the tunnel under a different organization without switching your active org. |
--key <token> | string | Override the auth token. Useful for CI/CD or scripted environments. |
--no-logs | boolean | Suppress per-request log output in the terminal. |
--local | boolean | Advertise the tunnel on your LAN via mDNS in addition to the public URL. |
--local-only | boolean | LAN-only mode — no remote tunnel is opened. See below. |
Custom subdomains and domains
Request a specific subdomain with--subdomain:
--domain:
Password protection
Add HTTP basic auth to your tunnel:Password-protected tunnels require a paid plan. If you’re on a free plan, the tunnel will fail to open with a
PASSWORD_REQUIRES_PAID error.LAN-only mode
--local-only opens a server accessible only to devices on your local network. No remote tunnel is created, so no authentication is required.
local-<port> (e.g. local-3000). Override it with --subdomain:
LAN advertising alongside a public tunnel
Use--local (not --local-only) to get both a public URL and LAN access at the same time:
WebSocket support
WebSocket connections are proxied automatically through HTTP tunnels. No extra flags or configuration are needed. You’ll seeWS log entries in the terminal as WebSocket connections open and close.
Switching organizations temporarily
Use--org to open a tunnel under a specific organization without changing your active org:
Stopping the tunnel
PressCtrl+C to stop the tunnel. OutRay shuts down gracefully and the public URL becomes inaccessible.