🚧 Work in Progress Website

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

Homebrew (Recommended)

# Add the Eldrin Tunnel tap
brew tap eldrin-project/eldrin-tunnel

# Install Eldrin Tunnel
brew install eldrin-tunnel

# Verify installation
eldrin-tunnel --help

✅ Works on both Intel and Apple Silicon Macs

Winget (Recommended)

# Install via Windows Package Manager
winget install EldrinProject.EldrinTunnel

# Verify installation
eldrin-tunnel --help

Scoop (Alternative)

# Add the Eldrin Tunnel bucket
scoop bucket add eldrin-tunnel https://github.com/eldrin-project/homebrew-eldrin-tunnel

# Install Eldrin Tunnel
scoop install eldrin-tunnel

# Verify installation
eldrin-tunnel --help

Manual Installation

  1. Download the latest eldrin-tunnel-x86_64-pc-windows-msvc.zip from our releases page
  2. Extract the eldrin-tunnel.exe file
  3. Add the directory to your PATH or place in a directory already in PATH

Snap (Recommended)

# Install via Snap Store
sudo snap install eldrin-tunnel

# Verify installation
eldrin-tunnel --help

Homebrew

# Install Homebrew (if not already installed)
/bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"

# Add the Eldrin Tunnel tap
brew tap eldrin-project/eldrin-tunnel

# Install Eldrin Tunnel
brew install eldrin-tunnel

# Verify installation
eldrin-tunnel --help

Manual Installation

  1. Download the latest eldrin-tunnel-x86_64-unknown-linux-gnu.tar.gz from our releases page
  2. Extract the archive: tar -xzf eldrin-tunnel-x86_64-unknown-linux-gnu.tar.gz
  3. Move the binary to your PATH: sudo mv eldrin-tunnel-x86_64-unknown-linux-gnu /usr/local/bin/eldrin-tunnel
  4. Make it executable: sudo chmod +x /usr/local/bin/eldrin-tunnel

Quick Start

Get your tunnel running in 3 simple steps:

1

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
2

Start Eldrin Tunnel

Connect your local service to our secure tunnel servers.

# Quick mode - replace 3000 with your port
eldrin-tunnel --port 3000

# With authentication for persistent endpoints
eldrin-tunnel --port 3000 --login your@email.com
3

Share your public URL

Copy the generated URL and share it with anyone!

✅ Tunnel allocated successfully!
   Tunnel ID: abc123def
   Public URL: https://f48482dc-035f-4e7d-8c7d-89593cfec5a6.tunnel.eldrin.link
   
🌍 Your local service is now accessible worldwide!

Authentication Mode

For persistent endpoints and advanced features, authenticate with your account:

# Login with your email
eldrin-tunnel --login your@email.com

# Or login without specifying email
eldrin-tunnel --login

Authentication Features

🔐 Secure Login

Browser-based authentication with JWT tokens for secure access.

📋 Persistent Endpoints

Claim and manage your own custom subdomains that persist across sessions.

🔄 Tunnel Restoration

Automatically reconnect to your existing tunnels when restarting the client.

📊 Usage Analytics

Track your tunnel usage and monitor connection statistics.

Available Commands

  • --login - Authenticate for persistent endpoints
  • --port - Specify local port to tunnel
  • --server - Choose tunnel server
  • --token - Use existing authentication token
  • --url - Request specific subdomain

Server Configuration

Configure your tunnel client to connect to our servers:

🌐 Default Server

tunnel.eldrin.link

Primary tunnel server

🔐 Auth Service

auth.eldrin.link

Authentication & management

🌍 Website

eldrin.link

Documentation & profile

🔗 Tunnel URLs

*.tunnel.eldrin.link

Your public endpoints

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
  • Check your local service configuration and ensure it's responding quickly
  • 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

🔌 "Connection failed"

  • Check your internet connection
  • Ensure the tunnel server is accessible
  • Try restarting the tunnel client

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.