This repository contains a Java application template for Camunda Platform 8 using Spring Boot and a docker-compose.yaml file for local development. For production setups we recommend to use our helm charts.
- Documentation
- Camunda Platform SaaS
- Getting Started Guide
- Releases
- Helm Charts
- Zeebe Workflow Engine
- Contact
The application requires a running Zeebe engine. You can run Zeebe locally using the instructions below for Docker Compose or have a look at our recommended deployment options for Camunda Platform.
Run the application via
./mvnw spring-boot:run
Swagger UI: http://localhost:8080/swagger-ui.html
ℹ️ The docker-compose file in this repository uses the latest compose specification, which was introduced with docker-compose version 1.27.0+. Please make sure to use an up-to-date docker-compose version.
ℹ️ The Docker required is 20.10.16+
To stand-up a complete Camunda Platform 8 Self-Managed environment locally the docker-compose.yaml file in this repository can be used.
The full enviornment contains these components:
- Zeebe
- Operate
- Tasklist
- Optimize
- Identity
- Elasticsearch
- KeyCloak
Clone this repo and issue the following command to start your environment:
docker-compose up -d
Wait a few minutes for the environment to start up and settle down. Monitor the logs, especially the Keycloak container log, to ensure the components have started.
Now you can navigate to the different web apps and log in with the user demo and password demo:
- Operate: http://localhost:8081
- Tasklist: http://localhost:8082
- Optimize: http://localhost:8083
- Identity: http://localhost:8084
- Elasticsearch: http://localhost:9200
- KeyCloak: http://localhost:18080
The workflow engine Zeebe is available using gRPC at localhost:26500.
To tear down the whole environment run the following command
docker-compose down -v
If Optimize, Identity, and Keycloak are not needed you can use the docker-compose-core.yaml instead which does not include these components:
docker-compose -f docker-compose-core.yaml up -d
Zeebe, Operate, Tasklist, along with Optimize require a separate network from Identity as you'll see in the docker-compose file.
In addition to the local environment setup with docker-compose, you can download the Camunda Desktop Modeler to locally model BPMN diagrams for execution and directly deploy them to your local environment.
Feedback and updates are welcome!
Fork this repository on GitHub and rename/refactor the following artifacts:
groupId,artifactId,name, anddescriptionin pom.xmlprocess/@idandprocess/@namein src/main/resources/models/camunda-process.bpmnProcessConstansts#BPMN_PROCESS_IDin src/main/java/org/example/camunda/process/solution/ProcessConstants.java- Java package name, e.g.
org.example.camunda.process.solution.*
By forking this project, you can stay connected to improvements that we do to this template and simply pull updates into your fork, e.g. by using GitHub's Web UI or the following commands:
git remote add upstream [email protected]:camunda-community-hub/camunda-8-process-solution-template.git
git pull upstream main
git push