Tunnels

Tunnels make your local server accessible from the internet. This is useful for testing webhooks, sharing dev previews, and developing Discord Activities that require HTTPS endpoints.

Quick tunnel

The fastest way to get a public URL. No configuration needed.

Using the CLI flag:

npx robo dev -t

Or as a standalone command:

npx robo tunnel start

This creates a temporary Cloudflare Quick Tunnel with a random *.trycloudflare.com URL. The URL changes each time you start a new tunnel.

Static tunnel

For a persistent URL at your own domain, configure Cloudflare credentials:

config/plugins/robojs/server.mjs

export default {
	tunnel: {
		enabled: true,
		cloudflare: {
			domain: 'example.com',
			apiKey: 'your-api-key',
			zoneId: 'your-zone-id',
			accountId: 'your-account-id'
		}
	}
}

config/plugins/robojs/server.mjs

export default {
	tunnel: {
		enabled: true,
		cloudflare: {
			domain: 'example.com',
			apiKey: 'your-api-key',
			zoneId: 'your-zone-id',
			accountId: 'your-account-id'
		}
	}
}

Or use environment variables:

.env

CLOUDFLARE_DOMAIN=example.com
CLOUDFLARE_API_KEY=your-api-key
CLOUDFLARE_ZONE_ID=your-zone-id
CLOUDFLARE_ACCOUNT_ID=your-account-id

The plugin creates a tunnel at robo.example.com and automatically manages DNS records and tunnel credentials. On first run, it writes CLOUDFLARE_TUNNEL_ID and CLOUDFLARE_TUNNEL_TOKEN to your .env file for subsequent runs.

Managing tunnels

List running tunnels:

npx robo tunnel list

Stop a specific tunnel:

npx robo tunnel stop <id>

Stop all tunnels:

npx robo tunnel stop --all

Tunnel modes

Detached (default): The tunnel runs in the background. Use robo tunnel list and robo tunnel stop to manage it.

Attached: The tunnel runs in the foreground and stops when you press Ctrl+C:

npx robo tunnel start --attach

CLI options

Options for robo tunnel start:

Flag	Description
`-p, --port <number>`	Port to tunnel (default: `PORT` env or 3000)
`-u, --url <url>`	Custom URL to tunnel
`-a, --attach`	Run in foreground mode
`-v, --verbose`	Show detailed output

Custom providers

Create your own tunnel provider by implementing the TunnelProvider interface:

import type { TunnelProvider, TunnelProviderConfig, TunnelInstance } from '@robojs/server'

const myProvider: TunnelProvider = {
	name: 'my-provider',
	isInstalled: () => true,
	install: async () => {},
	start: async (url: string, config?: TunnelProviderConfig): Promise<TunnelInstance> => {
		// Start your tunnel and return the instance
	},
	stop: async (instance: TunnelInstance) => {
		// Stop the tunnel
	}
}


const myProvider = {
	name: 'my-provider',
	isInstalled: () => true,
	install: async () => {},
	start: async (url, config) => {
		// Start your tunnel and return the instance
	},
	stop: async (instance) => {
		// Stop the tunnel
	}
}

Use it in config:

config/plugins/robojs/server.mjs

export default {
	tunnel: {
		enabled: true,
		provider: myProvider
	}
}

config/plugins/robojs/server.mjs

export default {
	tunnel: {
		enabled: true,
		provider: myProvider
	}
}

Environment variables

Variable	Description
`CLOUDFLARE_DOMAIN`	Domain for static tunnel
`CLOUDFLARE_API_KEY`	Cloudflare API bearer token
`CLOUDFLARE_ZONE_ID`	DNS zone ID
`CLOUDFLARE_ACCOUNT_ID`	Account ID
`CLOUDFLARE_TUNNEL_ID`	Tunnel ID (auto-populated)
`CLOUDFLARE_TUNNEL_TOKEN`	Tunnel auth token (auto-populated)
`CLOUDFLARED_VERSION`	Cloudflared binary version (default: latest)

Tunnels

Quick tunnel

Static tunnel

Managing tunnels

Tunnel modes

CLI options

Custom providers

Environment variables

Next steps

CLI

Configuration

On this page