Skip to main content
Every machine gets a domain at <machine>.boxd.sh, or at <machine>.nyc.boxd.sh for a machine in New York. The boxd proxy terminates TLS and forwards HTTP requests to your machine.

Get started

nginx is pre-installed and configured on port 8000, but disabled by default. Start it:
Visit https://myapp.boxd.sh to see a welcome page.

Run your own app

The default proxy detects the port your app listens on among 80, 443, 8080, 8000, 3000, 5000 and 5173, and falls back to 8000. A process listening on one of those ports is reachable over HTTPS with no configuration.

Change the port

To send the default proxy to a specific port, set it from your laptop:
Inside a machine, leave out --vm to target the machine you are in:

Subdomain proxies

Create additional subdomains pointing to different ports:
Each of these is a proxy, the same kind of object as the default one. The Proxies guide covers them in full: creating and removing them, changing target ports, and how routing works.

WebSockets

WebSocket connections work transparently. The proxy detects the Upgrade: websocket header and forwards the connection.

Non-HTTP traffic

The HTTPS proxy speaks HTTP only: it terminates TLS and routes by domain. To reach a database, an SSH daemon, a game server, or any other raw protocol, add a raw port forward instead:
See Port forwarding.

HTTP to HTTPS

Plain HTTP requests to http://<machine>.boxd.sh are redirected to HTTPS automatically. HSTS headers are included in the response.

DNS

A DNS record is created automatically when your machine boots. The record has a 60-second TTL.
Every machine’s domain points at the proxy’s shared public IP. The proxy routes HTTPS by SNI (the domain in the TLS handshake) and SSH by the machine’s dedicated port, so the same IP fronts every machine. A machine in New York points at New York’s proxies.

Custom domains

You can use your own domain instead of <machine>.boxd.sh: one domain for one machine, or a wildcard delegated to your whole organization. See Custom domains.