Install with Docker Compose
This guide walks through deploying Yardrail on a single host using Docker Compose. This is the recommended path for local development and small single-server deployments. For Kubernetes deployments, see the Kubernetes section.
Overview
The Docker Compose stack runs all services on one machine:
1. Clone the repository
git clone https://github.com/yardrail/yardrail.git
cd yardrail
2. Configure environment variables
Copy the example environment file and fill in the secrets:
cp .env.example .env
Edit .env and set the required values:
# Generate these with: openssl rand -hex 32
POSTGRES_PASSWORD=<generate>
SESSION_SIGNING_KEY=<generate>
WORKER_AUTH_TOKEN=<generate>
# Generate with: openssl rand -base64 32
DB_ENCRYPTION_KEY=<generate>
MINIO_ROOT_PASSWORD=<generate>
# Temporal payload encryption — format: id:base64key
# Generate with: echo "key1:$(openssl rand -base64 32)"
PAYLOAD_ENCRYPTION_KEYS=<generate>
Never commit .env to version control — it's gitignored by default.
3. Start the stack
docker compose up -d
This starts all services: PostgreSQL, MinIO, Temporal, the frontend, and the worker. The frontend applies database migrations automatically on startup.
4. Enable Docker socket access for the worker
By default, the docker-compose.yml does not mount the Docker socket into the worker container.
The worker needs it to run CWL tool containers via the Docker executor.
Create a docker-compose.override.yml:
services:
yardrail-worker:
volumes:
- /var/run/docker.sock:/var/run/docker.sock
# The worker process needs permission to access the socket.
# Option A: run as root (simple, fine for local dev)
user: "0:0"
# Option B: add the worker user to the docker group (more secure)
# group_add:
# - "${DOCKER_GID:-999}"
Then restart the worker:
docker compose up -d yardrail-worker
Without the socket mount, the worker starts and polls Temporal successfully, but any workflow that executes a CWL container tool will fail with a Docker connection error.
5. Access the services
| Service | URL | Notes |
|---|---|---|
| Yardrail frontend | http://localhost:8080 | Web UI and API |
| Temporal UI | http://localhost:8233 | Workflow execution visibility |
| MinIO console | http://localhost:9001 | S3 bucket browser (user: yardrail) |
Configuration reference
The worker reads its configuration from environment variables. These are set in
docker-compose.yml and pull secrets from .env:
| Variable | Default | Description |
|---|---|---|
TEMPORAL_ADDRESS | temporal:7233 | Temporal server address |
TEMPORAL_NAMESPACE | default | Temporal namespace |
FRONTEND_GRPC_ADDR | yardrail-frontend:9090 | Frontend interlink gRPC |
WORKER_AUTH_TOKEN | (from .env) | Interlink auth token |
PAYLOAD_ENCRYPTION_KEYS | (from .env) | Temporal payload codec |
S3_ENDPOINT | minio:9000 | MinIO endpoint |
S3_ACCESS_KEY | yardrail | MinIO access key |
S3_SECRET_KEY | (from .env) | MinIO secret key |
S3_BUCKET | yardrail-workflows | Workflow artifacts bucket |
EXECUTOR | docker | Container executor (default) |
Stopping and resetting
# Stop all services (preserves data)
docker compose down
# Stop and delete all data (database, S3 objects, Temporal history)
docker compose down -v
Next steps
- Verify Installation — confirm the stack is working end-to-end
- Docker Executor Architecture — understand how the Docker executor works under the hood