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.

If your slipway.yaml references a private image — via services.*.image or via a base image in a private registry — slipway needs credentials to pull it. Configure them once at the org level; no per-service config is required.

Add a registry

Under Settings → Registries → Add registry:
  1. Registry host. The hostname (e.g. ghcr.io, index.docker.io, 123456789012.dkr.ecr.us-east-1.amazonaws.com).
  2. Username and password (or token).
  3. Save.
slipway stores the credentials encrypted, alongside the org’s other secrets.

How they’re used

At deploy time, slipway assembles a Docker config.json from every registry configured for the org and materializes it as a Kubernetes Secret in:
  • The build namespace, so BuildKit can pull private base images during RUN/FROM steps.
  • The tenant namespace, so the kubelet can pull images referenced by services.*.image.
The deploy emits a registries_resolved event with the list of hosts wired up for that run.

Common registries

RegistryHostnameUsernamePassword
Docker Hubindex.docker.ioyour Docker Hub usernamea Docker Hub access token
GitHub Container Registryghcr.ioyour GitHub usernamea personal access token with read:packages
Amazon ECR<acct>.dkr.ecr.<region>.amazonaws.comAWSthe output of aws ecr get-login-password (note: rotates every 12 hours, see below)
Google Artifact Registry<region>-docker.pkg.dev_json_keythe full JSON of a service-account key
Azure Container Registry<name>.azurecr.ioyour service principal ID or admin userthe corresponding password

A note on ECR

Amazon ECR auth tokens expire every 12 hours. Storing the output of get-login-password directly means re-rotating it twice a day, which is impractical. If you’re using ECR heavily, prefer images on a registry that supports long-lived credentials (GHCR, Docker Hub) or contact us about IAM-role-based auth.

Permissions

RoleView hostsView passwordsCreate / update / delete
Vieweryesnono
Developeryesnono
Adminyesnoyes
Owneryesnoyes