Documentation
01 / Manual

Feature-by-feature deployment documentation

Installation, configuration, sites, databases, previews, automation, and server provisioning organized as a systematic product manual.

Read the first page
17 pages7 sectionsFeature reference
Browse by section
7 areas
01Getting Started1
02Core Concepts2
03Configuration4
04Deployment Features4
05CLI Commands4
06Automation1
07Tooling1
Complete index

Everything you need to ship

17 entries
01Getting Started

Getting Started

Install the CLI, create a first shipper.yml, and run validate, plan, and apply in the intended order.

02Core Concepts

Concepts

The core mental model behind Shipper: providers, projects, profiles, and resource lifecycle.

03Core Concepts

Resource Lifecycle

How Shipper thinks about creating, reusing, updating, and destroying provider-managed resources.

04Configuration

Configuration Reference

Entry point for structuring shipper.yml, with separate reference pages for concepts, providers, projects, profiles, commands, and deployment features.

05Configuration

Providers

How the providers block is structured, how projects reference providers, and where provider-specific options belong.

06Configuration

Projects

How projects are defined, how repositories and paths are configured, and which settings are shared across profiles.

07Configuration

Profiles

How deployment environments are modeled, including branch selection, domains, previews, databases, and infrastructure.

08Deployment Features

Site Lifecycle

How Shipper creates, updates, deploys, and destroys application sites across environments.

09Deployment Features

Server Lifecycle

How Shipper provisions, reuses, and cleans up servers as part of a deployment profile.

10Deployment Features

Database Lifecycle

How databases are declared, named, created, linked, and cleaned up across deployment profiles.

11Deployment Features

PR Preview Environments

How preview environments are named, deployed, and cleaned up for pull requests.

12CLI Commands

Validate

What `shipper validate` checks, when to run it, and how to interpret failures.

13CLI Commands

Plan

What `shipper plan` previews, how to use it safely, and how to read create, reuse, and destroy intent.

14CLI Commands

Apply

What `shipper apply` executes, how it uses the selected profile, and what to verify before running it.

15CLI Commands

Destroy

What `shipper destroy` removes, how destroy intent should be reviewed, and where cleanup boundaries come from.

16Automation

GitHub Actions Workflows

How to wire Shipper into CI workflows for production deploys, preview environments, and cleanup jobs.

17Tooling

Build and Distribution

How the CLI is packaged, released, and distributed across local installs, binaries, and GitHub Actions.