Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.compartment.dev/llms.txt

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

Compartment is a self-hosted deployment platform that turns any Git repository into a running application. Define your services in a single compartment.yml file, run compartment deploy, and Compartment handles building, routing, and promoting your app — with zero downtime.

Quick Start

Deploy your first application in minutes with the Compartment CLI.

Installation

Install Compartment on your own infrastructure using Docker.

Configuration

Learn how to configure services, builds, and routing with compartment.yml.

CLI Reference

Full reference for every Compartment CLI command and flag.

​
How it works

1

Install Compartment

Run compartment install to deploy the Compartment platform on your server. You’ll get a fully working control plane, container runtime, and routing layer.
2

Initialize your project

In your repository, run compartment init to create a compartment.yml descriptor. This links your repo to a project and defines your services.
3

Deploy your app

Run compartment deploy from your project root. Compartment builds your services, runs readiness checks, and promotes them to live traffic automatically.
4

Manage and iterate

Use compartment status, compartment logs, and compartment promote to monitor deployments and ship with confidence using zero-downtime rollouts.

​
Key features

Multi-service apps

Deploy multiple services from one repository with shared routing and per-service configuration.

Zero-downtime deploys

Candidate builds are promoted only after passing readiness checks. Roll back instantly if needed.

Environment variables

Manage plain and sensitive variables scoped to environments or individual services.

SSO & access control

Configure OIDC single sign-on and role-based access for your team.