Skip to main content

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.

OutRay is a fast, secure, and open-source tunneling solution that lets you share local servers with anyone, anywhere. Create HTTP, TCP, or UDP tunnels in seconds, bring your own domain, and collaborate with your team — all from a single CLI.

Quick Start

Install the CLI and open your first tunnel in under a minute.

CLI Reference

Explore every command, flag, and option available in the OutRay CLI.

Framework Plugins

Auto-tunnel your Next.js, Express, Vite, or NestJS dev server.

Self-Hosting

Deploy your own OutRay instance on your own infrastructure.

What you can do with OutRay

HTTP Tunnels

Expose web servers with custom subdomains and automatic TLS.

TCP Tunnels

Tunnel databases, game servers, or any TCP service.

UDP Tunnels

Forward UDP traffic for DNS, VoIP, and TFTP.

Custom Domains

Bring your own domain with automatic TLS certificate provisioning.

Teams

Collaborate with role-based access across multiple organizations.

Observability

Monitor request traffic, view analytics, and debug tunnels live.

Get started in 3 steps

1

Install the CLI

Install OutRay globally with npm:
npm install -g outray
2

Log in to your account

Authenticate via browser — no manual token copy-paste:
outray login
3

Open your first tunnel

Expose a local server running on port 3000:
outray http 3000
You’ll receive a public URL like https://your-name.tunnel.outray.app that anyone can visit.

Why OutRay?

  • Open source — the entire stack is open under AGPL-3.0; inspect, fork, and self-host freely.
  • All protocols — HTTP, TCP, and UDP tunnels from a single tool.
  • Developer integrations — drop-in plugins for Next.js, Express, Vite, and NestJS.
  • Team-ready — organization support, role-based access, and reserved subdomains.
  • Config-file driven — define all your tunnels in a single config.toml and start them with one command.

Build docs developers (and LLMs) love