Note
This deployment is based on the Camunda 8 Self-Managed - Docker Compose project by Camunda GmbH, licensed under the Apache License 2.0. This project extends the original deployment with additional configuration, scripts, and documentation for production use.
This is a complete Camunda 8 Self-Managed deployment using Docker Compose with all components including Web Modeler and backup capabilities.
- Docker and Docker Compose must be installed and up-to-date
- Tested with: Docker
28.3.2and Docker Compose2.38.2 - Minimum required: Docker
28.0.0and Compose2.38.0 - Note: Older versions may work but are not guaranteed
- Tested with: Docker
- Version Control: Git must be set up to manage Docker Compose files and configurations
- Development Environment: Choose based on personal preferences, but should provide suitable tools for editing and testing Docker Compose files
- Recommended: Visual Studio Code with extensions:
Container Tools,Docker, andYAML
- Recommended: Visual Studio Code with extensions:
- Ports
80,443,26500available
| Environment | vCPU | RAM | Disk |
|---|---|---|---|
| Minimum | 6 | 12 GB | 10 GB |
| Recommended | 11 | 22 GB | 192 GB |
| Production | 12 | 24 GB | 250 GB |
-
Configure Environment
cp env.sample .env # Edit .env and set your HOSTNAME -
Create Required Directories
./bin/directory_creation_util.sh
-
Configure Host-Specific Settings
# Copy sample configuration for your hostname cp -r configuration/runtime_local_SAMPLEHOST configuration/runtime_local_$(grep HOSTNAME .env | cut -d'=' -f2) # Edit the copied configuration files to match your environment
-
Start the Platform
./bin/startup.sh
-
Access Applications
- Web Modeler: https://HOSTNAME/modeler
- Tasklist: https://HOSTNAME/tasklist
- Operate: https://HOSTNAME/operate
- Optimize: https://HOSTNAME/optimize
- Identity: https://HOSTNAME/identity
- Keycloak: https://HOSTNAME/auth
| File | Purpose |
|---|---|
docker-compose.yaml |
Main compose file that includes all component files |
env.sample |
Template for environment configuration |
.env |
Your local environment configuration (create from env.sample) |
| File | Components | Purpose |
|---|---|---|
base-infrastructure.yaml |
elasticsearch, postgres | Core infrastructure services |
identity.yaml |
keycloak, identity | Authentication and user management |
core-services.yaml |
zeebe, operate, tasklist, connectors | Main Camunda platform services |
optimize.yaml |
optimize | Process analytics and reporting |
web-modeler.yaml |
web-modeler-* services | Process modeling and collaboration |
reverse-proxy.yaml |
traefik | Load balancer and SSL termination |
kc-connector.yaml |
kc-connector | Keycloak integration connector |
| Directory | Purpose | Data Persisted |
|---|---|---|
container.postgres/ |
PostgreSQL database | Identity, Keycloak, and Web Modeler data |
container.elasticsearch/ |
Elasticsearch | Process data, logs, and search indices |
container.zeebe/ |
Zeebe workflow engine | Process instances and workflow data |
container.web-modeler-db/ |
Web Modeler database | Process models and collaboration data |
container.operate/ |
Operate service | Operational data and configurations |
container.tasklist/ |
Tasklist service | Task management data |
container.optimize/ |
Optimize service | Analytics and reporting data |
container.traefik/ |
Traefik proxy | SSL certificates and proxy configurations |
| Directory | Purpose |
|---|---|
configuration/ |
Runtime configuration files |
configuration/runtime_local_*/ |
Host-specific configurations |
backups/ |
Automated backup archives |
| Script | Purpose | Usage |
|---|---|---|
bin/startup.sh |
Start all services | ./bin/startup.sh [options] |
bin/shutdown.sh |
Stop all services | ./bin/shutdown.sh [options] |
Startup Options:
-h, --help: Show help-d, --detached: Start in background (default)-f, --follow: Start and follow logs-v, --verbose: Enable verbose output
Shutdown Options:
-h, --help: Show help-v, --volumes: Remove volumes (default)-k, --keep: Keep volumes (preserve data)-f, --force: Force shutdown without confirmation
| Script | Purpose | Usage |
|---|---|---|
bin/make_backup.sh |
Create system backup | ./bin/make_backup.sh [options] |
bin/restore_backup.sh |
Restore from backup | ./bin/restore_backup.sh [options] |
bin/cleanup.sh |
Clean directory structure | ./bin/cleanup.sh [options] |
Backup Options:
-h, --help: Show help-d, --destination: Backup destination (default: ./backups)-n, --name: Custom backup name-f, --force: Force backup without stopping services-q, --quick: Quick backup (skip service shutdown)-v, --verbose: Enable verbose output
Restore Options:
-h, --help: Show help-b, --backup: Backup file to restore-f, --force: Force restore without confirmation-v, --verbose: Enable verbose output
| Script | Purpose |
|---|---|
bin/directory_creation_util.sh |
Create required directories and set permissions |
Key configuration files loaded in order:
.env- Main environment configurationconfiguration/runtime.env- Runtime defaultsconfiguration/runtime_local_${HOSTNAME}.env- Host-specific overridesconfiguration/runtime_local_${HOSTNAME}/*.env- Component-specific configs
| Variable | Purpose | Default |
|---|---|---|
HOSTNAME |
Your domain/hostname | camunda.example.com |
TIMEZONE |
System timezone | Europe/Berlin |
CAMUNDA_*_VERSION |
Component versions | Latest 8.7.x |
CORS_ALLOWED_ORIGINS |
CORS configuration | https://${HOSTNAME} |
RESOURCE_AUTHORIZATIONS_ENABLED |
Enable resource-based auth | false |
MULTI_TENANCY_ENABLED |
Enable multi-tenancy | false |
- Zeebe: Workflow engine for process orchestration
- Operate: Operations dashboard for monitoring and troubleshooting
- Tasklist: Human task management application
- Identity: User and client management
- Optimize: Advanced analytics and reporting
- web-modeler-db: PostgreSQL database for models
- web-modeler-restapi: Backend REST API
- web-modeler-webapp: Frontend web application
- web-modeler-websockets: Real-time collaboration
- mailpit: Local SMTP server for email testing
- elasticsearch: Search and analytics engine
- postgres: Relational database
- keycloak: Identity and access management
- traefik: Reverse proxy and load balancer
- connectors: Out-of-the-box system integrations
- Web Modeler: https://HOSTNAME/modeler
- Tasklist: https://HOSTNAME/tasklist
- Operate: https://HOSTNAME/operate
- Optimize: https://HOSTNAME/optimize
- Identity: https://HOSTNAME/identity
- Keycloak Admin: https://HOSTNAME/auth
- Uses Keycloak for centralized authentication
- Default admin credentials configured in identity.yaml
- CORS configured for secure cross-origin requests
- All PostgreSQL databases (Identity, Keycloak, Web Modeler)
- Elasticsearch indices and data
- Zeebe process data and snapshots
- All container.* directories with service data
- Configuration files
- Automated backups with timestamp naming
- Pre-restore backups created automatically
- Configurable backup retention
- Quick backup option for minimal downtime
- Port conflicts: Ensure ports 80, 443, 26500 are available
- Resource issues: Ensure minimum 6 vCPU, 12GB RAM, 10GB disk space
- Memory issues: For production, use at least 12 vCPU, 24GB RAM, 250GB disk
- Permission errors: Run
./bin/directory_creation_util.sh - SSL issues: Check Traefik configuration and certificates
# View all logs
docker compose logs -f
# View specific service logs
docker compose logs -f zeebe
docker compose logs -f web-modeler-webapp# Check service status
docker compose ps
# Check specific service health
docker compose exec zeebe zeebe-health-check- Backups: Run
./bin/make_backup.shregularly - Updates: Update component versions in configuration files
- Monitoring: Check logs and service health regularly
- Update version variables in
configuration/runtime.env - Create backup before updating
- Follow Camunda's upgrade guides
- Camunda 8 Documentation
- Docker Compose Documentation
- Traefik Documentation
- Camunda Platform 8 Docker Compose Repository - Base deployment version 8.7
- Resource Requirements: Ensure adequate resources based on your environment:
- Minimum: 6 vCPU, 12GB RAM, 10GB disk
- Recommended: 11 vCPU, 22GB RAM, 192GB disk
- Production: 12 vCPU, 24GB RAM, 250GB disk
- Always backup before major changes
- Monitor resource usage, especially memory and disk space
- Keep backups in a separate location
Caution
This is the product of a students bachelor's thesis and it might not be up to all requirement of your specific environment. Please use this reposity carefully with a grain of salt.