# slipway

> Preview environments for every push and pull request. Ship from a manifest.

## Docs

- [Core concepts](https://docs.slipway.sh/concepts.md): The shape of how slipway thinks about deployments.
- [Custom domains](https://docs.slipway.sh/configuration/domains.md): Serve previews under your own parent zone instead of the platform's apps domain.
- [Preview authentication](https://docs.slipway.sh/configuration/preview-auth.md): Gate previews with a shared token, GitHub org membership, or per-deployment tokens.
- [Private registries](https://docs.slipway.sh/configuration/registries.md): Configure pull credentials for private container registries.
- [Repositories](https://docs.slipway.sh/configuration/repositories.md): Enable, disable, and configure per-repo behavior.
- [Secrets](https://docs.slipway.sh/configuration/secrets.md): Encrypted key/value pairs for credentials and tokens.
- [Variables](https://docs.slipway.sh/configuration/variables.md): Plaintext key/value pairs for config that isn't sensitive.
- [Events](https://docs.slipway.sh/deployments/events.md): The append-only timeline behind every deployment.
- [Lifecycle](https://docs.slipway.sh/deployments/lifecycle.md): Queued → building → deploying → healthy → gc. What happens at each step.
- [Logs](https://docs.slipway.sh/deployments/logs.md): Live SSE streams, replay, and org-wide search.
- [Manual & ephemeral deploys](https://docs.slipway.sh/deployments/manual.md): Deploy any commit on demand, optionally with a TTL.
- [Metrics](https://docs.slipway.sh/deployments/metrics.md): What the org metrics dashboard shows you.
- [Triggers](https://docs.slipway.sh/deployments/triggers.md): Three ways a deployment starts.
- [Introduction](https://docs.slipway.sh/introduction.md): Preview environments for every push and pull request. Ship from a manifest.
- [GitHub installations](https://docs.slipway.sh/organization/github.md): One slipway org corresponds 1:1 with one GitHub installation.
- [Invites](https://docs.slipway.sh/organization/invites.md): Add people to your org by sending them a one-time accept link.
- [Members & roles](https://docs.slipway.sh/organization/members.md): Four roles, ordered from least to most privileged.
- [Quickstart](https://docs.slipway.sh/quickstart.md): From zero to a live PR preview in about five minutes.
- [Event kinds](https://docs.slipway.sh/reference/events.md): Every value a deployment event's kind field can take.
- [slipway.yaml field index](https://docs.slipway.sh/reference/fields.md): Every shipped field, one row each, with type and notes.
- [Glossary](https://docs.slipway.sh/reference/glossary.md): Words slipway uses, defined.
- [Limits & defaults](https://docs.slipway.sh/reference/limits.md): The numbers behind slipway.
- [Deployment statuses](https://docs.slipway.sh/reference/statuses.md): Every value a deployment's status field can take.
- [Environment & secrets](https://docs.slipway.sh/slipway-yaml/env-and-secrets.md): The ${secret.*} and ${var.*} substitution syntax.
- [Examples](https://docs.slipway.sh/slipway-yaml/examples.md): Worked specs for common shapes.
- [Healthchecks](https://docs.slipway.sh/slipway-yaml/healthchecks.md): Startup, readiness, and liveness probes — HTTP, TCP, exec, gRPC.
- [Overview](https://docs.slipway.sh/slipway-yaml/overview.md): The slipway.yaml manifest — what it is, where it lives, what it controls.
- [Services](https://docs.slipway.sh/slipway-yaml/services.md): Every field of services.<name> — build, image, ports, env, resources.
- [Validation](https://docs.slipway.sh/slipway-yaml/validation.md): When the spec is checked, what's caught where, and what's intentionally not modeled.

## OpenAPI Specs

- [openapi](https://docs.slipway.sh/api-reference/openapi.json)