Platform
How Ploy builds and deploys your projects — Git sources, preview deployments, ploy.yaml, environment variables, and the rules that decide what gets deployed.
Platform
Ploy turns a Git repository into running deployments. Pick a source, add a ploy.yaml, and every push builds and deploys. This section covers everything around that loop: where your code comes from, how a project is configured, how environments and secrets reach your build and runtime, and how branches, monorepos, and templates map to deployments.
How a deployment works
- Push to a connected GitHub repository or to a Ploy Git repository.
- Ploy reads
ploy.yamlat the pushed commit to find the projectkind, build command, output directory, and bindings. - The build runs with your dashboard environment variables available, and the result is uploaded.
- The deployment goes live: pushes to the production branch replace production, and every other branch gets a preview deployment with its own URL.
- Roll back by redeploying any earlier deployment from the dashboard.
Pushes can be skipped per branch pattern or commit-message marker with the deploy section of ploy.yaml, or from Project Settings → Preferences → Deploy Rules.
Project types
kind in ploy.yaml tells Ploy how to build and run a project:
kind: dynamic
build: pnpm build
out: dist
db:
DB: default| Kind | Use it for |
|---|---|
static | Static sites built with any framework — only the out directory is served |
nextjs | Next.js apps with server-side rendering, through @meetploy/nextjs |
dynamic | Workers, Vite and TanStack Start apps, and other worker + assets projects |
worker | Alias for dynamic |
Bindings such as db, queue, workflow, cron, ai, and auth are declared next to the build settings. The full reference is on the Configuration page.
In this section
Configuration
Every ploy.yaml option: kind, build, out, base, bindings, assets, migrations, and deploy rules.
Ploy Git
Deploy without GitHub. Push to a repository hosted by Ploy with plain git.
Move a project's source
Move a project between GitHub and Ploy Git with its full history.
Environment Variables
Dashboard secrets for builds and runtime, and .env files for local development.
Skew Protection
Pin a client's requests to the deployment that served its page.
Monorepos
Deploy several projects from one repository, each with its own ploy.yaml.
Deploy to Ploy button
Let users clone a GitHub template and deploy it in one guided flow.
Related
- CLI —
ploy devruns your project locally with emulated bindings;ploy pushandploy gitwork with Ploy Git repositories. - Self-hosting — run the whole platform on your own infrastructure.
How is this guide?
Last updated on