Getting Started with Eldrin Tunnel

Eldrin Tunnel makes it easy to share your local development server with anyone on the internet. Perfect for demos, testing, and collaboration.

Installation

🍺 macOS (Homebrew - Recommended)

# Install Eldrin Tunnel
brew tap eldrin-project/eldrin-tunnel
brew install eldrin-tunnel

# Verify installation
eldrin-tunnel --help

💻 Windows & Linux

Visit our releases page
Download the appropriate version for your system
Extract the binary and place it in your PATH

Quick Start

Get your tunnel running in 3 simple steps:

Start your local service

Make sure your local application is running on a specific port.

# Examples of local services
python -m http.server 3000     # Python web server
npm start                       # React/Vue/Angular (usually port 3000)
rails server -p 4000           # Ruby on Rails
php -S localhost:8000          # PHP built-in server

Start Eldrin Tunnel

Connect your local service to our secure tunnel servers.

# Quick mode - replace 3000 with your port
eldrin-tunnel ws://tunnel.eldrin.io:8080 3000

# With custom timeout (default 30 seconds)
eldrin-tunnel ws://tunnel.eldrin.io:8080 3000 60

Share your public URL

Copy the generated URL and share it with anyone!

✅ Tunnel is live!
   Tunnel ID: abc123def
   Public URL: https://abc123def.tunnel.eldrin.io
   
🌍 Your local service is now accessible worldwide!

Interactive Mode

For a more user-friendly experience, use interactive mode with a beautiful terminal interface:

# Start interactive mode
eldrin-tunnel

Interactive Features

🌍 Region Selection

Choose from US East/West, Europe, Asia, or Local Development servers for optimal performance.

📋 Text Selection

Click and drag to select tunnel URLs and logs, then copy with Ctrl+C.

📊 Real-time Logs

See incoming requests in real-time with color-coded log levels.

🖱️ Mouse Support

Full mouse support for clicking, scrolling, and text selection.

Available Commands

/start - Start a new tunnel with guided setup
/login - Authenticate for premium features
/status - View current tunnel status
/logging - Configure log levels
/exit - Stop tunnel and exit

Server Regions

Choose the server region closest to you or your users for the best performance:

🇺🇸 US East

ws://tunnel.eldrin.io:8080

Virginia, USA

🇺🇸 US West

ws://tunnel-west.eldrin.io:8080

California, USA

🇪🇺 Europe

ws://tunnel-eu.eldrin.io:8080

Frankfurt, Germany

🇯🇵 Asia

ws://tunnel-asia.eldrin.io:8080

Tokyo, Japan

Pricing & Limits

Free Tier

✅ 1 tunnel
✅ 30 requests per minute
✅ All regions available
✅ Community support

🎉 Soft Launch Special

✅ 5 tunnels
✅ 30 requests per minute
✅ All regions available
✅ Priority support
🎁 First 100 users only

Coming Soon: Pro plans starting at €2/month for 2 tunnels, with additional tunnels at €1/month each.

Troubleshooting

Common Issues

🚫 "Connection refused" or "Failed to connect"

Make sure your local service is running on the specified port
Check that no firewall is blocking the connection
Try a different port or restart your local service

⏰ "Gateway Timeout" errors

Your local service might be taking too long to respond
Increase the timeout: eldrin-tunnel ws://tunnel.eldrin.io:8080 3000 60
Check if your local service is responding quickly

🚨 "Too Many Requests" (HTTP 429)

You've hit the rate limit (30 requests per minute on free tier)
Wait for the rate limit to reset (60 seconds)
Consider upgrading to a paid plan for higher limits

🔌 "WebSocket connection failed"

Check your internet connection
Try a different region server
Make sure you're using the correct WebSocket URL (ws:// not http://)

Support

💬 Community Support

Join our community for help from other users and developers.

GitHub Discussions

📧 Email Support

Get direct help from our team for technical issues.

support@eldrin.io

🏢 Enterprise Support

Custom solutions and dedicated support for businesses.

enterprise@eldrin.io

💡 Pro tip: When contacting support, include your operating system, the exact command you ran, and any error messages you see.