Docker deployment
Docker deployment builds container images and pushes them to a remote container registry.
How it works
When docker is included in $VORTEX_DEPLOY_TYPES, the deployment script:
- Builds Docker images for your services using
docker-compose.yml - Tags images with the deployment reference (branch, tag, or commit)
- Pushes images to the configured container registry
- The hosting platform pulls and deploys the new images
Configuration
Environment variables
| Variable | Required | Default | Location | Description |
|---|---|---|---|---|
VORTEX_DEPLOY_CONTAINER_REGISTRY | Yes | .env | Registry URL (e.g., docker.io, ghcr.io) | |
VORTEX_DEPLOY_CONTAINER_REGISTRY_USER | Yes | CI | Registry username | |
VORTEX_DEPLOY_CONTAINER_REGISTRY_PASS | Yes | CI | Registry password or token | |
VORTEX_DEPLOY_CONTAINER_REGISTRY_IMAGE | No | Project name | .env | Base image name |
Setup
-
Add
dockerto theVORTEX_DEPLOY_TYPESvariable in your.envfile:.envVORTEX_DEPLOY_TYPES=docker -
Configure your container registry:
.envVORTEX_DEPLOY_CONTAINER_REGISTRY=ghcr.io
VORTEX_DEPLOY_CONTAINER_REGISTRY_IMAGE=your-org/your-project -
Add registry credentials to your CI provider's environment variables:
VORTEX_DEPLOY_CONTAINER_REGISTRY_USER=your-username
VORTEX_DEPLOY_CONTAINER_REGISTRY_PASS=your-token
Image tagging
Images are tagged based on the deployment context:
| Context | Tag format | Example |
|---|---|---|
| Branch | Branch name (sanitized) | develop, feature-auth |
| Tag | Tag name | 1.0.0, v2.1.0 |
| PR | pr-{number} | pr-123 |
| Commit | Short SHA | abc1234 |
Supported registries
- Docker Hub (
docker.io) - GitHub Container Registry (
ghcr.io) - AWS ECR (
*.dkr.ecr.*.amazonaws.com) - Google Container Registry (
gcr.io) - Azure Container Registry (
*.azurecr.io) - Any OCI-compliant registry
Use cases
- Kubernetes deployments - Pull images from registry to deploy
- Container orchestration platforms - AWS ECS, Google Cloud Run, etc.
- Custom infrastructure - Any system that can pull and run Docker images
See also
- Docker tool - Docker configuration in Vortex