Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.slipway.sh/llms.txt

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

By default, every public service is served at <prefix>-<dep-id>.<platform-apps-domain>. If you’d rather serve previews under your own zone — <prefix>-<dep-id>.preview.acme.com, for example — claim a custom domain in your org. Custom domains are managed at the org level. The slipway.yaml references a verified zone by name in ports[].domain; the zone itself is claimed and verified in the UI.

​
Claim a domain

Under Settings → Domains → Add domain:
  1. Enter the parent zone you want to serve previews under, e.g. preview.acme.com.
  2. slipway gives you a CNAME target — copy it into your DNS provider as a wildcard record: 
    *.preview.acme.com   CNAME   <target-from-slipway>
  3. Back in slipway, click Verify. slipway resolves the CNAME from the public internet to confirm it points where it should.
Once verified, the domain is available to every repo in the org.

​
Use it in a spec

Add domain: to the public port: 
services:
  web:
    build: { context: . }
    ports:
      - { port: 3000, public: true, domain: preview.acme.com }
    resources: { cpu: "500m", memory: "512Mi" }
    healthcheck:
      readiness: { http: { path: /healthz, port: 3000 } }
Deployed URLs become:
  • PR previews: web-pr-42.preview.acme.com
  • Default-branch / manual: web-<dep-id>.preview.acme.com
If the domain: in a spec doesn’t match a verified domain for the org, the deploy fails with a clear error at the deploy phase. slipway won’t ask cert-manager to issue a certificate for a zone the org hasn’t proven it owns.

​
TLS

slipway provisions per-host TLS certificates automatically through cert-manager + Let’s Encrypt. Renewal is automatic. There’s nothing you need to configure on the cert side.

​
Multiple domains per org

You can claim as many parent zones as you need. Different repos (or different services in the same repo) can use different zones.

​
Removing a domain

Removing a verified domain from Settings → Domains stops new deployments from using it, but doesn’t tear down existing certificates or Ingresses. Tear down any healthy deployments still using the domain before removing it if you want a clean cut.