Skip to content

outray-tunnel/outray

Repository files navigation

Vercel OSS Program

OutRay

Expose your localhost to the internet. Outray is an open-source tunneling solution that lets you share local servers with anyone, anywhere.

Features

  • HTTP Tunnels - Expose web servers with custom subdomains
  • TCP Tunnels - Tunnel any TCP service (databases, game servers, etc.)
  • UDP Tunnels - Tunnel UDP traffic (DNS, VoIP,TFTP etc.)
  • Custom Domains - Bring your own domain with automatic TLS
  • Dashboard - Monitor traffic, view analytics, manage tunnels
  • Team Support - Collaborate with organizations and role-based access

Quick Start

Install the CLI

npm install -g outray

Create a tunnel

# HTTP tunnel
outray http 3000

# TCP tunnel (e.g., for PostgreSQL)
outray tcp 5432

# UDP tunnel
outray udp 53

Requirements

  • Node.js 20+
  • PostgreSQL
  • Redis
  • Tiger Data (TimescaleDB)

Project Structure

outray/
├── apps/
│   ├── cli/             # CLI client
│   ├── cron/            # Background jobs
│   ├── internal-check/  # Domain verification for Caddy
│   ├── landing/         # Marketing website
│   ├── tunnel/          # Tunnel server
│   └── web/             # Dashboard & API
├── shared/              # Shared utilities
└── deploy/              # Deployment configs

Documentation

Visit outray.dev/docs for full documentation.

Contributing

Contributions are welcome! See CONTRIBUTING.md for guidelines.

License

AGPL-3.0-only