Getting started

Run the console, connect your broker, and inspect your first live message.

User journey steps
Typical workflow after deployment
Need a broker too? Follow the complete MQTT lab for a self-contained example, then use the user guide for everyday workflows.

Start with Docker Compose

For the local container stack, install Git and Docker with Compose. Run these commands from a terminal. The first build downloads dependencies and can take several minutes.

git clone https://github.com/vijayptiwari/eventore.git
cd eventore
docker compose -f docker/docker-compose.stack.yml up -d --build

Open http://localhost:8088 for the console. The API is on http://localhost:8080; the optional MCP service included in this stack is on port 3100.

Bring a broker: this stack starts EventOre, not a messaging broker. In the Connections screen, use an address reachable from the backend container. On Docker Desktop, host.docker.internal reaches services on your host; localhost inside a container refers to that container.

Continue with Create your first connection below. For test brokers and advertised-listener configuration, use the local development guide.

Prerequisites for running from source

Quick start (local development)

1. Build and run the backend

cd backend
mvn -DskipTests package
java -jar eventore-server/target/eventore-server-0.2.1.jar

The API listens on http://localhost:8080. Swagger UI: /swagger-ui.html.

2. Build and run the frontend

cd frontend
npm install
npm run dev

Vite dev server proxies API calls to the backend (see vite.config.ts).

3. Verify control plane registration

curl -s http://localhost:8080/api/v1/control/plane | jq .activeProtocols

You should see protocols matching the provider modules in your build (default: all eight).

4. Create your first connection

  1. Open the UI → Connections.
  2. Choose a stream platform preset (e.g. generic Kafka) or enter settings manually.
  3. Set broker URL (e.g. localhost:9092 for Kafka).
  4. Add credentials if your cluster uses SASL/SSL.
  5. Click Save connection, then Test.

5. Browse and stream

  1. Go to Browse, select your connection, pick a topic or queue.
  2. Click Add to streams — the stream appears in the side panel.
  3. Open Live Stream to watch messages in real time.
Tip: Streams are stored in browser cookies. Closing the tab and returning restores your workspace.

Quick start (published images)

Pick stream providers in Helm; the chart pulls the matching GHCR backend tag (kafka, kafka-kinesis, etc.). Details: Published artifacts.

docker pull ghcr.io/vijayptiwari/eventore-backend:0.2.1-kafka

helm install eventore oci://ghcr.io/vijayptiwari/charts/eventore --version 0.2.1 \
  -f deploy/helm/eventore/values-stream-kafka.yaml

Slim deployment (Kafka + Kinesis only)

mvn -DskipTests -Pkafka-kinesis -P!providers-all -pl eventore-server -am package
java -jar eventore-server/target/eventore-server-0.2.1.jar \
  --spring.profiles.active=kafka-kinesis

Only Kafka and Kinesis appear in the UI protocol list. See Configuration.

Check your setup

Next steps