Skip to content

Docker Compose

One docker-compose.yaml for the whole stack: backing services, ovc-backend (API + worker), guacd and ovc-frontend, using the published container images. guacd stays on the internal Compose network: only ovc-frontend’s server talks to it (GUACD_URL: ovc-guacd:4822), never the browser.

By default ovc-backend and ovc-frontend wire up to Keycloak (or any other OIDC/OAuth2 provider) for real login - see OIDC provider and Roles for how roles are read and what each one grants.

No IdP, quick testing only: set OVC_AUTH_MODE: stub on both ovc-backend and ovc-frontend instead - every request is then treated as a fixed admin user, no login and no IdP needed. ovc-frontend shows a standing warning dialog while this is active; never use it beyond a trusted network. For local UI development the bypass is also available outside Docker - see Running in dev mode.

Terminal window
git clone https://github.com/openvcenter/Open-vCenter.git
cd Open-vCenter/quick-install/docker
./up.sh
curl localhost:8000/api/health # {"ok":true,"db":true,"cache":true,"rabbit":true}

up.sh generates the frontend’s session secret into .env on first run, so use it rather than a bare docker compose up. Open http://localhost and log in as admin / admin. ./down.sh tears it down (--purge also drops the data volumes and .env).

Hosts are added and agents installed from the frontend once you’re logged in - see Running in dev mode › Agent for the Add Host / Setup Agent steps.