Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/outray-tunnel/outray/llms.txt

Use this file to discover all available pages before exploring further.

By default, OutRay assigns a random subdomain each time you start a tunnel. Custom domains let you use a domain you own — for example, tunnel.yourcompany.com — giving you a stable, branded URL that never changes between sessions.

​
Add a custom domain

1

Open the Domains section

In the OutRay dashboard, navigate to Domains in the left sidebar. Click Add Domain.
2

Enter your domain

Type the full hostname you want to use (e.g., tunnel.yourcompany.com) and confirm.
3

Create a CNAME record

In your DNS provider, create a CNAME record for the hostname pointing to:
edge.outray.app
The exact steps vary by provider, but the record should look like this:
TypeNameValue
CNAMEtunnel.yourcompany.comedge.outray.app
DNS changes can take a few minutes to a few hours to propagate depending on your provider and TTL settings.
4

Verify and wait for TLS

Back in the dashboard, click Verify next to your domain. OutRay checks for the CNAME record and automatically provisions a TLS certificate. The domain status changes to Active once the certificate is ready.

​
Use a custom domain in the CLI

Pass the --domain flag when starting a tunnel: 
outray 3000 --domain tunnel.yourcompany.com
The tunnel is immediately reachable at https://tunnel.yourcompany.com.

​
Use a custom domain in config.toml

To make the domain permanent for a tunnel, add it to your outray/config.toml: 
[tunnel.web]
protocol = "http"
local_port = 3000
custom_domain = "tunnel.yourcompany.com"
Then start your tunnels as usual: 
outray start
Custom domains are scoped to the organization that verified them. All members of the organization can use the domain with their own tunnels.

​
Removing a custom domain

To remove a domain, open Domains in the dashboard, click the menu on the domain card, and select Delete. The domain is released immediately and the TLS certificate is revoked.

Build docs developers (and LLMs) love

Get started for freeTalk to us