Skip to content

Demo Environment ​

The demo runs Hegemony in Docker on one machine, next to a small lab of simulated routers and servers, a Git server and a mail sink. Five short stories show what the platform is for. It lives in its own repository, hegemony-demo, which has the requirements, the install command, the users, the walkthrough and troubleshooting. This page covers only how the demo relates to this repository.

The demo is a demonstration, not a deployment. Its credentials are public knowledge, so do not expose a demo instance to a network you do not control. To run Hegemony for real, start from Production Hardening.

Install ​

bash
curl -fsSL https://hegemony.sh/install.sh | sh

The installer checks the machine first, installs into ./hegemony-demo, and prints where to sign in. The hegemony-demo README lists its options and the day-to-day commands (task up, task down, task reset, task logs).

Try a platform change in the demo ​

The demo normally runs the platform release it pins. To run it on images built from your own checkout of this repository instead, use task up:local in the demo directory:

bash
HEGEMONY_PLATFORM_DIR=/path/to/hegemony task up:local

It builds the images with this repository's deploy/compose/docker-compose.prod-local.yml, so the four plugin repositories must be beside your checkout, as for local development (the list is in CONTRIBUTING.md). A plain task up goes back to the release. The demo's CONTRIBUTING.md has the details.

How the demo uses this repository ​

The demo is a separate Compose project, hegemony-demo. Its deploy/compose/compose.sh runs docker compose with this repository's docker-compose.prod.yml and the auth, s3, openbao-internal, dind and registry overlays, then the demo's own overlay, which adds the demo's plugin wheels to the released api and worker images and loads its data through instance bootstrap. Every argument goes to docker compose, so the operations runbooks work against the demo through it, run from the demo directory. For example:

bash
deploy/compose/compose.sh ps
deploy/compose/compose.sh exec temporal tctl --address temporal:7233 --ns default workflow list
deploy/compose/compose.sh run --rm --service-ports temporal-ui    # Temporal console on 127.0.0.1:8088

This repository has no demo tasks: the earlier forwarding tasks are gone, and so is the demo's secondary external Vault.

Running next to other stacks ​

Every stack runs flow containers in its own Docker-in-Docker sandbox (deploy/compose/docker-compose.dind.yml) on its own network. A demo and a dev or prod stack on the same host must therefore use subnets that do not overlap: by convention 172.28.102.0/24 for the demo, 172.28.100.0/24 for dev and 172.28.101.0/24 for prod. The host ports must not clash either: the demo takes 8080, 8081, 8025, 9000 and 3000 on 127.0.0.1.

Authentication ​

The demo's Keycloak realm ships sample users and organization groups. Production authentication imports only application clients and roles, with no sample users or organization groups. Provision production users and assign their roles through your identity provider. See production hardening.

Released as open source under the AGPL-3.0-or-later license. Development is sponsored by Rexonix s.r.o. Contact — [email protected].