Ployz docs

Ployz turns your Linux servers into a deployment platform: Git push deploys, preview environments, databases and https, on servers you own. These docs cover the dashboard at ployz.dev.

Writing or editing a page? Read STYLE.md first.

Start here

New to Ployz? Follow these steps from a first deploy to real users.

1. Deploy an example app: Quick start
2. Deploy your own app: Deploy from GitHub
3. Configure it: Variables and Databases
4. Test changes: Preview environments
5. Get ready for production: Production checklist

Getting started

• Introduction: whether Ployz fits, what you need, what it costs
• Quick start: an example app on your server at an https address
• The basics: how your app is organized and how a change ships

Deploy

• Deploy from GitHub: connect GitHub, deploy on push, wait for CI, monorepos
• Deploy a Docker image: public and private registries
• Deployments: staged changes, Deploy, following and fixing a deployment

Services

• Services: add, rename, restart or delete a service
• Service settings: what each field does; the dashboard links here
• Variables: variables, secrets, references between services
• Databases: PostgreSQL, MySQL, Redis and MongoDB, connecting, backups
• Volumes: files that survive deploys
• Configs: shared text files mounted read-only into services
• Move a volume: mirror a volume and move it to another server
• Restore a volume: bring a volume back to an earlier point as a new volume
• Domains: generated addresses, custom domains, https
• Private networking: how services reach each other
• Scaling and multiple servers: replicas, more servers, when a server goes down

Environments

• Environments and branches: production, staging and branches of them
• Preview environments: a copy of your app for every pull request

Builds

• How builds work: what triggers a build, when one is reused, build logs
• Railpack and Dockerfiles: building without a Dockerfile, build commands
• Where builds run: your servers or GitHub Actions, and in what order
• Build resources and cache: limit what builds use, clear the cache

Servers

• Add a server: requirements, the install command, the ports to open
• Manage servers: status, upgrades, removing a server

Observe

• Logs: service logs and deployment logs
• Metrics: CPU, memory, network and disk per service and server
• Uptime: whether visitors can reach each service, checks after each deploy and on demand

Account

• Your account: your profile, where you're signed in, signing a browser out
• Organizations and billing: your organization, deleting it, Pro
• Notifications: choose which emails you get, and unsubscribe from one

More

• Production checklist: before you move real users
• The Ployz agent: ask the dashboard's agent to look around or deploy, and approve each deploy
• Connect an agent to Ployz Cloud: add Ployz to Claude, Codex or another MCP app with a link
• CLI and coding agents: install the CLI, set up your coding agent, MCP tools, tokens for CI
• Self-host Ployz Cloud: run the dashboard on your own infrastructure

Troubleshooting

• Builds: detection failures, out of memory, stuck builds
• Deployments: failed health checks, crashing services, queued deployments
• My app isn't reachable: error pages, wrong ports, domains and certificates
• Trace a request: which server answered, its deploy and replicas, Cloudflare
• Servers: install failures, servers that don't join or go offline, full disks