Configuration Reference

This page is the entry point for shipper.yml.

Read Configuration from the Outside In

1. understand the Concepts
2. define Providers
3. define Projects
4. define Profiles
5. configure feature-specific lifecycle pages as needed

Minimal Shape

providers:
  <provider_name>:
    # provider-specific settings

projects:
  <project_name>:
    provider: <provider_name>
    profiles:
      <profile_name>:
        branch: <branch>
        domain: <domain>

Configuration by Topic

• Providers
• Projects
• Profiles
• Site Lifecycle
• Database Lifecycle
• Server Lifecycle
• PR Preview Environments

Provider Capability Differences

General structure is documented here. Exact fields and feature support vary by provider:

• Ploi
• Laravel Forge
• cPanel
• EasyPanel

Failure Modes

• mixed provider and project naming: keep the provider key stable and reference it exactly from projects
• environment-specific settings placed at project level: move them into profiles
• provider-specific fields copied into shared docs without checking support: confirm against the provider page