Deploy
Topology and DNS
See how your services connect, and give them hostnames through a Cloudflare tunnel or a reverse proxy.
The topology canvas
Open Topology in the sidebar to see your workspace’s services. The canvas reads left to right in columns: the hostnames, the gateways that route traffic in, your containers inside their Docker networks (a network whose containers all run on one machine names it once at the top of its box), then anything you drew yourself. Each container shows what the runner last saw: healthy, running, stopped or failed. A failed or stopped container colours its whole path back to the hostname that reaches it, and the bar at the top counts them; click a count to bring the next one into view. Hover any card to light up the routes it is on and dim the rest. Click a service to open its stack.
The canvas follows what is deployed, so you can’t edit services, networks or routes on it. You can add your own nodes with External, such as an outside API a service calls, move cards around, and draw edges to note a relation: dashed with an arrow for “depends on”, dotted for “connects to”, solid for “mounts”. Drawing an edge wires nothing. Each workspace keeps its own arrangement and drawings; Arrange in lanes puts every card back in its column. The canvas opens at a zoom you can read and shows as many whole columns as fit; when more sit to the right, the edge fades and More moves over, and Back returns.
Gateways
A gateway is a Cloudflare tunnel or a reverse proxy that Nexul deploys to give one Docker network a way in from the internet. On the canvas it is a hub: hostnames wire in on the left, one row per route shows where traffic lands (service:port, plus the container’s address once known), and wires go out to the services on the right.
You rarely create one yourself: exposing a container or running Set up DNS creates the gateway it needs. To see or delete gateways, open Settings → DNS; each lists the hostnames it routes. A gateway belongs to the instance rather than a project, and shows on the topology of every workspace it routes a hostname into. Creating one, or running Set up DNS, takes DNS write and Deploy to on the machine it deploys to; a gateway’s stack is found only by someone who sees that machine and can read DNS.
Tunnels
Settings → DNS also lists the Cloudflare tunnels Nexul manages, each with the hostname routed into it. To delete one, click its bin icon. The confirm names what goes: the tunnel at Cloudflare, and its hostname route with the DNS record pointing at the tunnel.
A tunnel can’t be deleted while anything uses it. The delete is refused, and the message names what is in the way: a gateway running through the tunnel, a hostname exposed on it, the instance’s own address when the tunnel serves it, or the cloudflared stack that runs it. For example tunnel "edge" is still used by app.example.com, gateway on network web, cloudflared stack cloudflared-edge. Remove the gateways, exposures and stack first (a stack from its own page), and move the instance to another address if the tunnel carries it, then delete the tunnel. Deleting a tunnel also disconnects any connector still attached to it, so a cloudflared container that was still running doesn’t block the delete. Other DNS records you pointed at the tunnel by hand stay where they are. Deleting needs the Delete DNS permission, and the bin icon is hidden without it. The dns_tunnel_delete tool gives the same refusal.
Exposures
An exposure routes one hostname to one container.
- Open the stack and go to Settings → Exposures.
- Click Expose, pick the Container, type the Hostname and Container port, and pick the Zone.
- Click Expose.
Nexul picks or deploys the gateway, adds the DNS record, and the hostname shows on the canvas. Unexpose removes it. Exposing needs the Cloudflare connector.
On a reverse proxy gateway, Nexul also writes the route into the running Traefik, so the hostname answers within seconds and neither the gateway nor your stack is redeployed. Routes follow the exposures: one added or removed, or a container that comes back under a new name, rewrites them, and a redeployed gateway gets them back as soon as it is healthy. A machine whose runner was offline gets them as soon as the runner reconnects.
Setting up DNS
The instance gets its domain in the setup wizard. To change how it is reached later, open Settings → DNS and click Set up DNS. Connect Cloudflare under Settings → Connectors first.
- How should traffic reach this instance? Pick one; Reverse proxy is picked when the step opens:
- Bare public address: an A or AAAA record pointing straight at the server.
- Cloudflare tunnel: no open ports. cloudflared runs on a machine of yours and Cloudflare issues the certificate.
- Reverse proxy: Traefik on ports 80 and 443 of a machine, with Let’s Encrypt certificates. Both ports must be open to the internet.
- Deploy the tunnel (tunnel only): name it and pick the machine and Docker network. The picker lists only machines you may deploy to. If your token reaches several Cloudflare accounts, pick the one that owns the domain; a tunnel only serves its own account’s zones.
- Point your hostname: pick the zone and subdomain (or, for a bare address, the record type and target). For a tunnel, leave the local service empty to send the hostname to this instance. Three checks then confirm the route, the proxied DNS record, and that the hostname answers over HTTPS. A new record can take a minute.
- Go live confirms the instance answers at its new address. If the record is wrong, Delete this record removes the A, AAAA or CNAME record that step created, after a confirm that names it and what it pointed at. Deleting can’t be undone, and the step goes back to Point your hostname so you can create it again. It needs the Delete DNS permission, and the button is hidden without it. A tunnel’s hostname record is removed with the tunnel instead (see Tunnels).
The steps sit in a list on the left (Path, Tunnel, Hostname, Go live), one on screen at a time. A step opens once the one before it is done; opening a finished one shows what it set up, and only the path’s Change starts over, since the tunnel and the hostname hang off it.
Nexul deploys the tunnel or proxy itself, like any other stack. There is nothing to install by hand.
Cloudflare API token permissions
Create the token in the Cloudflare dashboard with:
| Permission | What Nexul uses it for |
|---|---|
| Zone → Zone: Read | Listing your zones and the account each belongs to |
| Zone → DNS: Edit | Creating the records that point hostnames at Nexul |
| Account → Cloudflare Tunnel: Edit | Creating tunnels |
| Zone → Analytics: Read | Optional. Counting the requests a tunnel hostname serves, for the stack page’s Requests card |
When you connect the token, Nexul checks each permission and names any that are missing. It also lists the domains the token can edit; make sure yours is among them. Analytics: Read is advisory: a token without it connects and works, and only the request counts of tunnel hostnames are missing. The dialog may also list two Account → Access permissions. They only served computers paired through a tunnel in the past, so you can leave them off.