This page guides you through the initial installation of the Zeebe broker and Zeebe Modeler for development purposes.
The easiest way to develop with Zeebe is using Docker. Using Docker provides you with a consistent environment, and we recommend it for development.
- Operating System:
- Windows/MacOS (development only, not supported for production)
Docker configurations for starting Zeebe using
docker-compose are available in the zeebe-docker-compose repository.
This repository contains several pre-defined configuration options:
- Single node
- Small cluster with and without gateway
- Single node with Operate
- Single node with simple monitor
This allows you to start using complex configurations with a single command. Later you can tailor these configurations to your needs, when you are ready to delve to that level.
Further instructions for using these configurations are in the README.
You can run Zeebe with Docker:
This will give you a a single broker node.
26500: Gateway API
26501: Command API (gateway-to-broker)
26502: Internal API (broker-to-broker)
The default data volume is under
/usr/local/zeebe/data. It contains
all data which should be persisted.
The Zeebe configuration is located at
The logging configuration is located at
The configuration of the docker image can also be changed by using environment variables. The configuration template files also contains information on the environment variables to use for each configuration setting.
Available environment variables:
ZEEBE_LOG_LEVEL- sets the log level of the Zeebe Logger (default:
ZEEBE_BROKER_NETWORK_HOST- sets the host address to bind to instead of the IP of the container.
ZEEBE_BROKER_CLUSTER_INITIALCONTACTPOINTS- sets the contact points of other brokers in a cluster setup.
Note: On systems which use a VM to run Docker containers like Mac and Windows, the VM needs at least 4GB of memory, otherwise Zeebe might fail to start with an error similar to:
If you are using Docker with the default Moby VM, you can adjust the amount of memory available to the VM through the Docker preferences. Right-click on the Docker icon in the System Tray to access preferences.
If you use a Docker setup with
docker-machine and your
default VM does
not have 4GB of memory, you can create a new one with the following command:
Verify that the Docker Machine is running correctly:
Configure your terminal:
Then run Zeebe:
To get the ip of Zeebe:
Verify that you can connect to Zeebe:
The Zeebe Modeler is an open-source desktop BPMN modeling application created specifically for Zeebe.