@outray/express

@outray/express

Express middleware to automatically expose your development server to the internet via Outray tunnel.

Installation

npm install @outray/express

Usage

Basic Usage

import express from 'express'
import outray from '@outray/express'

const app = express()

// Apply Outray middleware
outray(app)

app.get('/', (req, res) => {
  res.send('Hello World!')
})

app.listen(3000, () => {
  console.log('Server running on port 3000')
})

When you start your server in development mode, you'll see:

Server running on port 3000
  ➜  Tunnel:  https://quick-tiger.outray.app

With Options

import express from 'express'
import outray from '@outray/express'

const app = express()

outray(app, {
  subdomain: 'my-app',
  apiKey: process.env.OUTRAY_API_KEY,
  onTunnelReady: (url) => {
    console.log('Tunnel ready at:', url)
  }
})

app.listen(3000)

Options

interface OutrayPluginOptions {
  /** Subdomain to use (requires authentication) */
  subdomain?: string;
  
  /** Custom domain (must be configured in dashboard) */
  customDomain?: string;
  
  /** API key for authentication */
  apiKey?: string;
  
  /** Outray server URL */
  serverUrl?: string;
  
  /** Enable/disable tunnel (default: true in development) */
  enabled?: boolean;
  
  /** Suppress logs */
  silent?: boolean;
  
  /** Callback when tunnel is ready */
  onTunnelReady?: (url: string) => void;
  
  /** Callback on error */
  onError?: (error: Error) => void;
  
  /** Callback on reconnecting */
  onReconnecting?: () => void;
  
  /** Callback on close */
  onClose?: () => void;
}

Environment Variables

• OUTRAY_API_KEY - Your Outray API key
• OUTRAY_SUBDOMAIN - Custom subdomain
• OUTRAY_ENABLED - Set to "false" to disable
• OUTRAY_SERVER_URL - Custom server URL (default: wss://api.outray.dev/)