cipi.yml — config that ships with the code.

$ cipi yml generate myapp          # this app's current config, as a cipi.yml
$ cipi yml example myapp           # blank commented template, in myapp's namespace
$ cipi yml validate myapp          # parse and check, change nothing
$ cipi yml plan myapp              # show exactly what would change
$ cipi yml apply myapp [--yes]     # apply it
$ cipi yml auto myapp on|off|status  # apply after every successful deploy
$ cipi yml post-deploy myapp       # run the declared deploy.post steps now (5.2.3+)

$ cipi yml generate myapp > cipi.yml   # then commit it
$ cipi yml plan myapp                  # reports nothing to do

version: 1

app:
  # 8.3, 8.4 or 8.5 — must already be installed (cipi php install 8.5)
  php: "8.5"

  # The declared list replaces the current aliases: one you remove here is
  # removed from the server. The primary domain is not managed here.
  aliases:
    - "www.myapp.com"
    - "*.myapp.com"      # wildcard, for multi-tenant subdomains

  # Per-app php.ini overrides. Server-wide values stay with `cipi ini set`.
  ini:
    upload_max_filesize: 50M
    post_max_size: 60M
    memory_limit: 512M

  # 5.4.0+: canonical www redirect and basic auth (names or hashes, never passwords)
  www: to-root
  basic_auth:
    users:
      - admin

# Extra databases beyond the one created with the app. Credentials land in
# /home/myapp/shared/cipi-databases.env — never written back to the repo.
databases:
  - name: myapp_reporting
  - name: myapp_analytics
    engine: pgsql          # mariadb (default) or pgsql

workers:
  horizon: false           # true replaces the queue workers below

  # Laravel Reverb (5.1.2+). Cipi gives it a localhost port, a Supervisor program
  # and an nginx proxy for /app/{key} and /apps/{id}/… on this app's own domain, and
  # generates REVERB_APP_ID/KEY/SECRET (plus the VITE_ copies) in the .env the first
  # time it is enabled. An app with its own /app or /apps route cannot use it behind
  # the same domain — those paths belong to the Pusher protocol.
  reverb: false

  queues:
    - queue: default
      processes: 2
    - queue: emails
      processes: 1
      tries: 5
      timeout: 300

# Laravel scheduler (* * * * * artisan schedule:run)
schedule: true

# HTTP healthcheck. Probed every 5 minutes and right after every deploy.
# The URL must be one of this app's own domains.
# To remove an existing healthcheck, write only  health: { enabled: false }  (honoured since 5.3.0).
health:
  url: "https://myapp.com/up"
  expect: 200
  # grace: 8                      # seconds before the first probe after a deploy
  # postdeploy: false             # skip the check right after a deploy
  # rollback_on_unhealthy: true   # undo a release that fails the check
  #                               # (the code symlink only — migrations are NOT undone)

# Post-deploy steps (5.2.3+). Allowlisted runners only — artisan, npm/npx/yarn/pnpm,
# composer, or one relative php/node script under the release. No free shell.
# This is the one section that runs WITHOUT `cipi yml auto` being on.
deploy:
  post:
    - artisan cache:clear
    - artisan scout:import --force
    - npm run build
    - composer dump-autoload -o
  # post_on_failure: abort   # default warn: log + email, release stays live
  # 5.4.0+: the cipi app deploy-config options, e.g.
  # keep_releases: 5
  # snapshot: true

# 5.4.0+: Meilisearch for Scout (the engine is installed by root first)
search: false

# 5.4.0+: names (never values) the .env must carry, and allowlisted crons
env:
  required: [ STRIPE_KEY ]
crons:
  - every: 30m
    run: artisan queue:prune-batches

# 5.4.0+: path redirects and reverse proxy prefixes (each list replaces the current one)
redirects:
  - from: /blog/
    to: "https://blog.myapp.com/"
proxies:
  - prefix: /api/
    upstream: "http://127.0.0.1:3000"
    strip_prefix: true

# Backup strategy for this app. Profile names must be myapp or myapp-*.
backup:
  profiles:
    # Frequent and cheap: databases only, without the noisy tables.
    - name: myapp-db
      scope: db
      databases: ["myapp", "myapp_*", "tenant_*"]
      exclude_tables: ["*.jobs", "*.telescope_*"]
      every: 30m           # 5m/10m/15m/20m/30m, 1h..12h, 1d..28d
      keep: 48             # keep the last 48 runs
      destinations: [local]

    # Slower, complete, off-site and encrypted.
    - name: myapp-nightly
      scope: all           # all | files | db
      cron: "0 2 * * *"
      keep_days: 14
      destinations: [s3]
      encrypt: true

$ cipi yml auto myapp on       # reconcile after every successful deploy
$ cipi yml auto myapp status   # is it on?
$ cipi yml auto myapp off      # back to manual apply

$ cipi yml post-deploy myapp   # run the steps now, against current/
$ cipi yml plan myapp          # lists them under "After deploy"