From b0c95cdf686b84f5c1f0809c893b880912d01244 Mon Sep 17 00:00:00 2001 From: Jay Simons Date: Sun, 30 Aug 2026 15:32:57 -0500 Subject: [PATCH] docs(compose): document build server support for Compose Update the build server guide to cover Compose services with build: sections, and link from the Docker Compose overview. Co-authored-by: Cursor --- .../docs/core/docker-compose/index.mdx | 1 + .../docs/core/remote-servers/build-server.mdx | 41 ++++++++++++++++++- 2 files changed, 40 insertions(+), 2 deletions(-) diff --git a/apps/docs/content/docs/core/docker-compose/index.mdx b/apps/docs/content/docs/core/docker-compose/index.mdx index 7d41b506..aa1016f9 100644 --- a/apps/docs/content/docs/core/docker-compose/index.mdx +++ b/apps/docs/content/docs/core/docker-compose/index.mdx @@ -76,6 +76,7 @@ This section provides advanced configuration options for experienced users. It i - **Volumes**: To ensure data persistence across deployments, configure storage volumes for your application. +- **Build Server**: Optionally build services with `build:` on a dedicated server, push to a registry, and deploy prebuilt images on the target host. See [Build Server](/docs/core/remote-servers/build-server#docker-compose) for setup and behavior. - Build servers are currently **only available for Applications**. This feature is not supported for Docker Compose deployments. + Build servers are supported for **Applications** and **Docker Compose** services with `build:` sections in the compose file. ## Overview @@ -135,4 +135,41 @@ When you deploy an application with a custom build server: Build servers require a Docker registry to store built images. For detailed instructions on configuring a registry, see the [Docker Registry](/docs/core/registry) guide. +## Docker Compose + +Compose services can use the same build-server flow as applications when your compose file defines `build:` sections. + +### Configure a Compose service + +1. Open your Compose service in the dashboard. +2. Go to the **Advanced** tab. +3. Under **Build Server**, select both: + - **Build Server** — the host that runs `docker compose build` and pushes images + - **Build Registry** — where built images are stored +4. Click **Save**, then redeploy. + +Build Server and Build Registry must be set together, or both set to **None**. + + + Only services with a `build:` block are built on the build server and pushed to the registry. Services that use a prebuilt `image:` are unchanged. + + +### Deploy behavior + +When a build server is configured for Compose: + +1. Dokploy logs in to the registry on the build server. +2. Services with `build:` are built on the build server and tagged for your registry. +3. Images are pushed to the registry. +4. The deploy server logs in, pulls the images, and runs `docker compose up --no-build`. + +When no build server is set, Compose deploys behave as before and builds run on the deploy server. + +### Custom deploy commands + +If you use a custom deploy command, do **not** include `--build` when a build server is configured. Dokploy handles the build phase on the build server; the deploy server only pulls and starts containers. + +### Logs + +Build and deploy may run on different hosts. The **Deployments** tab shows the main deployment log (including the build phase when servers differ). After the build finishes, allow a few moments for the deploy server to pull images, then check the **Logs** tab to confirm containers started. Image pull activity on the deploy server may not appear in the build deployment log.