Examples

version: 1

services:
  - name: site
    type: static
    runtime: node
    runtimeVersion: "22"
    buildCommand: npm run build
    publish: dist
    notFound: /index.html

version: 1

services:
  - name: web
    runtime: docker
    ports:
      - port: 3000
        public: true
    env:
      NODE_ENV: production
    healthCheckPath: /api/health

version: 1

services:
  - name: api
    runtime: python
    runtimeVersion: "3.12"
    buildCommand: pip install -r requirements.txt
    command: ["gunicorn", "app:app", "--bind", "0.0.0.0:8000"]
    ports:
      - port: 8000
        public: true
    healthCheckPath: /healthz

version: 1

databases:
  - name: db
    engine: postgres
    version: "18"
    diskSizeGB: 20

services:
  - name: api
    rootDir: apps/api
    runtime: docker
    ports:
      - port: 8080
        public: true
    healthCheckPath: /healthz
    preDeploy: ["npm", "run", "migrate"]
    dependsOn: [db]
    env:
      DATABASE_URL: ${service.db.url}
      STRIPE_KEY: ${secret.STRIPE_KEY}
    cpu: 1
    memory: 1GB

  - name: site
    type: static
    rootDir: apps/web
    runtime: node
    buildCommand: npm run build
    publish: dist
    notFound: /index.html
    env:
      VITE_API_URL: ${service.api.public_url}

version: 1

databases:
  - name: queue
    engine: redis

services:
  - name: worker
    type: worker
    runtime: node
    runtimeVersion: "22"
    buildCommand: npm ci && npm run build
    command: ["node", "dist/worker.js"]
    maxShutdownDelaySeconds: 60
    env:
      REDIS_URL: ${service.queue.url}

version: 1

services:
  - name: nightly-report
    type: cron
    schedule: "0 3 * * *"
    runtime: docker
    command: ["node", "scripts/report.js"]
    env:
      DATABASE_URL: ${service.db.url}

version: 1

services:
  - name: uploads
    runtime: docker
    ports:
      - port: 8080
        public: true
    disk:
      mountPath: /var/lib/app/uploads
      sizeGB: 20

version: 1

services:
  - name: api
    image: ghcr.io/acme/api:1.4.2
    ports:
      - port: 8080
        public: true
    env:
      LOG_LEVEL: info

version: 1

buildFilter:
  paths:
    - apps/api/**
    - packages/shared/**
  ignoredPaths:
    - "**/*.md"

services:
  - name: api
    rootDir: apps/api
    runtime: docker
    ports:
      - port: 8080
        public: true

version: 1

services:
  - name: api
    runtime: docker
    cpu: 1
    memory: 2GB
    scaling:
      min: 2
      max: 10
      targetCPUPercent: 70
    ports:
      - port: 8080
        public: true
    healthCheckPath: /healthz

version: 1

previews:
  generation: automatic

services:
  - name: api
    runtime: docker
    cpu: 2
    memory: 4GB
    ports:
      - port: 8080
        public: true
    env:
      STRIPE_KEY: ${secret.STRIPE_KEY}
    previews:
      cpu: "500m"
      memory: 512MB
      env:
        STRIPE_KEY: ${secret.STRIPE_TEST_KEY}

version: 1

services:
  - name: api
    runtime: docker
    domain: acme.com
    prefix: api
    ports:
      - port: 8080
        public: true

  - name: site
    type: static
    runtime: node
    buildCommand: npm run build
    publish: dist
    domain: acme.com
    prefix: www

version: 1

services:
  - name: api
    runtime: docker
    ports:
      - port: 8080
        public: true
    healthcheck:
      startup:
        http: { path: /healthz, port: 8080 }
        failureThreshold: 30
        periodSeconds: 2
      readiness:
        http: { path: /ready, port: 8080 }
      liveness:
        tcp: { port: 8080 }