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.

slipway is a SaaS that watches your GitHub repositories and brings a real, isolated, internet-reachable copy of your application up in Kubernetes on every push to the default branch and on every open pull request. You write a slipway.yaml at the root of your repo. slipway parses it, builds the container images, applies a Deployment + Service + Ingress per service into a fresh tenant namespace, and gives you a URL.

​
What it’s for

  • PR previews. Every pull request gets its own live environment at a stable URL (<service>-pr-<n>.<your-apps-domain>). Tear-down is automatic on PR close.
  • Default-branch previews. Every push to main rebuilds and supersedes the previous environment.
  • Ephemeral one-offs. Manually deploy any commit for a fixed TTL straight from the UI.
slipway is a dev tool. Every deployment is ephemeral by design. Don’t ship production traffic to a slipway preview — ship production from somewhere else.

​
How it works

Under the hood, every deployment lives in its own Kubernetes namespace (sl-<dep-id>) with NetworkPolicy, ResourceQuota, LimitRange, and gVisor sandboxing. Build artifacts live in slipway-system; tenant pods can’t reach them or each other.

​
Where to start

Quickstart

Install the GitHub App, add a slipway.yaml, get a live preview URL in under five minutes.

Core concepts

Deployments, services, ephemeral previews, supersession. The shape of how slipway thinks.

slipway.yaml reference

Every shipped field of the manifest, with worked examples.

Deployment lifecycle

Queued → building → deploying → healthy → gc. What happens at each step.