mirror of
https://github.com/Dokploy/website.git
synced 2026-06-19 22:25:24 +02:00
docs: add Docker Registry configuration documentation and update Docker Compose utilities section
This commit is contained in:
115
apps/docs/content/docs/core/(Git-Sources)/Docker.mdx
Normal file
115
apps/docs/content/docs/core/(Git-Sources)/Docker.mdx
Normal file
@@ -0,0 +1,115 @@
|
||||
---
|
||||
title: Docker Registry
|
||||
description: 'Configure your Docker Registry repositories for deployments. This includes setting up access tokens, repository names, and authentication.'
|
||||
---
|
||||
|
||||
Dokploy provides seamless integration with Docker Registry repositories, allowing you to deploy applications directly from your container images. This feature is available for single applications and supports both public and private registries.
|
||||
|
||||
## Configuration Overview
|
||||
|
||||
To connect a Docker Registry to your application:
|
||||
|
||||
1. Navigate to your application's **General** tab
|
||||
2. Select **Docker** as the source
|
||||
3. Configure the following settings:
|
||||
|
||||
| Setting | Description |
|
||||
|---------|-------------|
|
||||
| **Docker Image** | Full name of the Docker image (e.g., `nginx:latest`, `myorg/myapp:v1.0`) |
|
||||
| **Docker Registry URL** | Registry URL (defaults to Docker Hub if not specified) |
|
||||
| **Docker Registry Username** | Username for registry authentication |
|
||||
| **Docker Registry Password** | Password or access token for authentication |
|
||||
|
||||
<Callout type="info">
|
||||
For private registries, authentication is required. For public images, you can leave the username and password fields empty.
|
||||
</Callout>
|
||||
|
||||
## Docker Hub Integration
|
||||
|
||||
Docker Hub is the default registry and supports both username/password and token-based authentication.
|
||||
|
||||
### Method 1: Username and Password
|
||||
|
||||
1. **Username**: Enter your Docker Hub username
|
||||
2. **Password**: Enter your Docker Hub password
|
||||
|
||||
### Method 2: Access Token (Recommended)
|
||||
|
||||
Using access tokens is more secure and allows fine-grained permissions:
|
||||
|
||||
1. **Create Access Token**:
|
||||
- Go to [Docker Hub Settings](https://hub.docker.com/settings/security) → **Personal Access Tokens**
|
||||
- Click **Generate New Token**
|
||||
- Set description: `Dokploy-Docker-Hub-Token`
|
||||
- Select **Read-only** permissions
|
||||
- Click **Generate**
|
||||
|
||||
2. **Configure in Dokploy**:
|
||||
- **Username**: Your Docker Hub username
|
||||
- **Password**: Paste the generated access token
|
||||
- **Registry URL**: Leave empty (defaults to Docker Hub)
|
||||
|
||||
3. **Deploy**: Click **Save** and then **Deploy** from the General tab
|
||||
|
||||
## GitHub Container Registry (GHCR)
|
||||
|
||||
GHCR allows you to store container images alongside your GitHub repositories.
|
||||
|
||||
### Prerequisites
|
||||
|
||||
- Your Docker image must already be published to GHCR
|
||||
- You need a GitHub Personal Access Token with appropriate permissions
|
||||
|
||||
### Setup Process
|
||||
|
||||
1. **Create GitHub Personal Access Token**:
|
||||
- Go to [GitHub Settings](https://github.com/settings/tokens) → **Personal Access Tokens**
|
||||
- Click **Generate new token (classic)**
|
||||
- Set token name: `Dokploy-GHCR-Token`
|
||||
- Select the following scopes:
|
||||
- `repo` - Access to repositories
|
||||
- `workflow` - Access to GitHub Actions
|
||||
- `write:packages` - Upload packages
|
||||
- `delete:packages` - Delete packages
|
||||
- Click **Generate token**
|
||||
|
||||
2. **Configure in Dokploy**:
|
||||
- **Docker Image**: `ghcr.io/username/repository:tag`
|
||||
- **Registry URL**: `ghcr.io`
|
||||
- **Username**: Your GitHub username
|
||||
- **Password**: Paste the generated personal access token
|
||||
|
||||
3. **Deploy**: Click **Save** and then **Deploy** from the General tab
|
||||
|
||||
|
||||
### Public Images
|
||||
|
||||
For public images from any registry:
|
||||
|
||||
- **Docker Image**: Full image path (e.g., `quay.io/prometheus/prometheus:latest`)
|
||||
- **Registry URL**: Registry domain (if not Docker Hub)
|
||||
- **Username**: Leave empty
|
||||
- **Password**: Leave empty
|
||||
|
||||
## Best Practices
|
||||
|
||||
<Callout type="tip">
|
||||
**Security Recommendations:**
|
||||
- Use access tokens instead of passwords when possible
|
||||
- Grant minimal required permissions to tokens
|
||||
- Regularly rotate access tokens
|
||||
- Use private registries for sensitive applications
|
||||
</Callout>
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
Common issues and solutions:
|
||||
|
||||
- **Authentication Failed**: Verify your credentials and token permissions
|
||||
- **Image Not Found**: Check the image name and tag spelling
|
||||
- **Pull Rate Limits**: Consider using authenticated requests or private registries
|
||||
- **Registry Timeout**: Verify the registry URL is accessible from your Dokploy instance
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -30,7 +30,7 @@ services:
|
||||
|
||||
When Isolated Deployments is enabled, Dokploy will:
|
||||
|
||||
1. Add a prefix to all your defined volumes and networks
|
||||
1. Add a prefix to all your defined networks
|
||||
2. Create a network based on your service's appName and associate it with each service in your compose file
|
||||
3. Connect the Traefik load balancer to this isolated network, maintaining service isolation while ensuring proper routing
|
||||
|
||||
|
||||
Reference in New Issue
Block a user