Skip to content

Commit 17acb93

Browse files
committed
docs: add guidance for using private registries with Docker Stack
- Included a callout in the Docker Compose documentation to inform users about the necessity of the `--with-registry-auth` flag when deploying with Docker Stack and private registries. - Explained the implications of not using the flag, including potential authentication errors on worker nodes. Resolved Dokploy/dokploy#3111
1 parent e3d947f commit 17acb93

File tree

1 file changed

+9
-0
lines changed
  • apps/docs/content/docs/core/docker-compose

1 file changed

+9
-0
lines changed

apps/docs/content/docs/core/docker-compose/index.mdx

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -43,6 +43,15 @@ We provide a webhook so that you can trigger your own deployments by pushing to
4343
This section provides advanced configuration options for experienced users. It includes tools for custom commands within the container and volumes.
4444

4545
- **Command**: Dokploy has a defined command to run the Docker Compose file, ensuring complete control through the UI. However, you can append flags or options to the command.
46+
47+
<Callout type="info" title="Using Private Registries with Docker Stack">
48+
If you're deploying with **Docker Stack** (Docker Swarm mode) using **replicas** and a **private registry**, you need to add the `--with-registry-auth` flag to ensure that registry credentials are properly distributed to all nodes in your swarm.
49+
50+
Without this flag, worker nodes may fail to pull images from private registries, resulting in authentication errors like "no such image" or "docker authentication failed".
51+
52+
This flag ensures that Docker shares the registry credentials with all swarm nodes during deployment, enabling them to authenticate and pull images from your private registry (GitHub Container Registry, Docker Hub private repos, etc.).
53+
</Callout>
54+
4655
- **Volumes**: To ensure data persistence across deployments, configure storage volumes for your application.
4756

4857
<ImageZoom

0 commit comments

Comments
 (0)