camunda/zeeqs repository overview

⁠ZeeQS - Zeebe Query Service

A Zeebe⁠ community extension that provides a GraphQL query API over Zeebe's data. The data is imported from the broker using an exporter (e.g. Hazelcast, Elasticsearch) and aggregated in the service.

⁠Docker Installation

The docker image for the ZeeQS application is published to GitHub Packages⁠.

docker pull ghcr.io/camunda-community-hub/zeeqs:2.0.0

• ensure that a Zeebe broker is running with a Hazelcast exporter (>= 1.0.0)
• forward the Hazelcast port to the docker container (default: 5701)
• configure the connection to Hazelcast by setting zeebe.client.worker.hazelcast.connection (default: localhost:5701)

For a local setup, the repository contains a docker-compose file⁠. It starts a Zeebe broker with the Hazelcast exporter and the ZeeQS application.

mvn clean install -DskipTests
cd docker
docker-compose up

• the GraphQL endpoint is available under the port 9000

Please see the repo⁠ for more installation instructions.

⁠Further Information

See the README⁠ on GitHub⁠.