orchestalabs/broka-broker repository overview

⁠BROKA — broker service (broka-broker)

The service that talks to your brokers on behalf of the BROKA console: it reads clusters, topics, consumer groups and messages, and carries out the changes the console asks for. The Community image carries the Kafka module. It needs network reachability to the brokers you register, shares the PostgreSQL database with broka-orchestrator, is called only by it, and publishes no port. The Compose recipe gives it 4 GiB of memory.

Health check: GET /actuator/health.

⁠What BROKA is

BROKA is a self-hosted operations console for message brokers. BROKA Community is free, runs on your own infrastructure and needs no account. It covers Apache Kafka and Kafka-compatible brokers: clusters, brokers, topics, consumer groups and lag, ACLs, Schema Registry, producing and browsing messages, with roles, environments and a tamper-evident audit trail around every change.

• Read-only and guarded environments; a reason is asked before destructive operations.
• Offset resets are previewed before anything moves, and each partition's before and after goes to the audit trail.
• One permission model and one audit trail across every connection.

BROKA Commercial adds Redis, RabbitMQ, Apache Artemis and Memcached. Its images are not published here.

⁠Run it

BROKA runs as four containers: broka-ui, broka-orchestrator, broka-broker and PostgreSQL. They are not meant to be run one by one; the Compose recipe wires them together.

1. Download compose.yml and .env.example from https://broka.dev/download⁠ into a directory of their own.

2. Copy .env.example to .env and generate the four secrets it asks for. The Compose file ships no defaults: while one is empty, docker compose up stops before creating any container. Keep BROKA_KEK safe: replace it and every stored broker credential becomes unreadable.

3. Start it:

   docker compose up -d
   

   Copy

4. Open http://localhost:3000 (or the address your reverse proxy serves) and create the first administrator.

Full guide: https://broka.dev/docs/deployment/docker-compose⁠ · Production checklist: https://broka.dev/guides/production-deployment-checklist⁠

⁠Verify the image

Every image is signed with BROKA's image-signing key and carries a CycloneDX SBOM attestation. With cosign 3 or later, for the version you run:

cosign verify --key https://broka.dev/keys/cosign.pub orchestalabs/broka-broker:<version>
cosign verify-attestation --key https://broka.dev/keys/cosign.pub --type cyclonedx orchestalabs/broka-broker:<version> > /dev/null

⁠Tags

The Tags tab lists every published version; the release notes say what each one changed. Images are built for linux/amd64. Run the same version of all three images together.

⁠Links

• Website: https://broka.dev⁠
• Documentation: https://broka.dev/docs⁠
• Guides: https://broka.dev/guides⁠
• Release notes: https://broka.dev/release-notes⁠
• Security: https://broka.dev/security-overview⁠

⁠Licence

BROKA is distributed under the BROKA Licence Agreement (https://broka.dev/licence⁠), which you accept by running a BROKA image. Community is free of charge; it is not open-source software.