Reference

Configuration

The platform.yaml file at the root of your project controls how it builds and deploys. Most fields are optional — sensible defaults are chosen based on framework auto-detection.

Build

Settings that control how your project is built.

SettingTypeDefaultDescription
build.commandstringauto-detectedThe shell command that produces your build output
build.outputstringauto-detectedThe folder containing the built files
build.installstringnpm ciThe command to install dependencies
build.nodestring20The Node.js version to use
build.envobject{}Environment variables available during build

Example:

build:
  command: npm run build
  output: dist/
  node: 20
  env:
    NODE_OPTIONS: --max-old-space-size=4096

Deploy

Settings that control how your project is deployed and routed.

SettingTypeDefaultDescription
deploy.frameworkstringautoFramework hint (e.g. next, astro, static)
deploy.routesarray[]Custom routing rules
deploy.headersarray[]Custom HTTP headers per path
deploy.redirectsarray[]URL redirects
deploy.regionstringautoPreferred deploy region

Example:

deploy:
  framework: next
  region: eu-west-1
  routes:
    - source: /api/*
      destination: /api/[...path].js
  headers:
    - path: /*
      headers:
        - key: X-Frame-Options
          value: DENY

Preview

Settings that control preview deploys for branches and pull requests.

SettingTypeDefaultDescription
preview.enabledbooleantrueWhether previews are enabled at all
preview.branches.includearray["**"]Branch patterns to deploy
preview.branches.excludearray[]Branch patterns to skip
preview.commentsbooleantrueComment on pull requests with preview URLs
preview.passwordstringnonePassword-protect preview URLs

Notifications

Where to send build and deploy events.

SettingTypeDefaultDescription
notifications.emailarray[]Email addresses to notify
notifications.slackobjectnoneSlack webhook configuration
notifications.eventsarray["deploy.failed"]Which events trigger notifications

Example:

notifications:
  events: [deploy.succeeded, deploy.failed]
  slack:
    webhook: https://hooks.example.com/...
    channel: "#deploys"

Plan limits

Limits that apply at the workspace level, by plan:

LimitFreeProBusinessEnterprise
Active projects325UnlimitedUnlimited
Concurrent builds1310Custom
Build minutes / month5006,00024,000Custom
Bandwidth / month100 GB1 TB5 TBCustom
Team members11050Unlimited
Custom domains per project110UnlimitedUnlimited

Need higher limits than Business offers? Contact sales to discuss Enterprise pricing.