OrbVis

A modern monitoring-visualisation platform — a community successor to NagVis, designed primarily for use inside Checkmk. Real-time live updates over Server-Sent Events, native Checkmk integration with main-menu entry and sidebar snapin, and a full board lineup — static, geo, force-directed topology, severity radar, SETUP folder tree and a design-first presentation editor. Built with FastAPI · Vue 3 · TypeScript · Vite · Pinia · D3.js, on the Checkmk design system.

Status: early release. OrbVis is primarily designed as a Checkmk integration and runs wherever Checkmk itself is supported. The standalone mode is developed and tested mainly on Ubuntu 24.04, but targets the same OS reach as Checkmk. Expect rough edges — issues and PRs are welcome. License: GPL-2.0-only.

A note on the name. "OrbVis" is a working title for this private project and is not published as a package on PyPI, npm, or similar registries. Two unrelated projects share the name — wojciech-graj/OrbVis (a realtime satellite-orbit visualizer) and staradutt/orbvis (a Python package for VASP bandstructure/DOS plotting). Their domains are distinct from monitoring visualisation, so confusion in practice should be minimal. Should this project ever be integrated into Checkmk upstream, the name would most likely be reassigned at that point.

Quickstart

Pre-built artefacts are on the Releases page.

Inside Checkmk (MKP)

omd su <site>
mkp add ~/orbvis-cmk-2.5.mkp   # pick MKP for your CMK major (2.3–2.6)
mkp enable orbvis
orbvis-setup

→ Full guide: docs/install.md#1-checkmk-mkp

Standalone (.deb / .rpm)

sudo dpkg -i orbvis_X.Y.Z_amd64.deb     # or: sudo rpm -i orbvis-X.Y.Z.x86_64.rpm
orbvis-install                          # invoke as a normal user

→ Full guide: docs/install.md#2-standalone-deb--rpm

Docker Compose

./bootstrap.sh                  # one-time: generates .env, ensures data/ dirs exist
docker compose up --build

Frontend on http://localhost:8741, API docs on http://localhost:8742/api/docs. → Full guide: docs/install.md#4-docker-compose

From source

./install.sh                    # standalone (systemd + nginx/Apache)
./install_cmk.sh <site-name>    # into an existing OMD site

→ Full guide: docs/install.md#3-from-source

⚠️ Production: keep uvicorn at one worker until the JWT blocklist moves to a shared store. All packaged install paths default to one worker. See production hardening.

Documentation

• Install guide — Checkmk MKP, standalone, Docker, source, production hardening
• Architecture — backend, frontend, state pipeline
• Troubleshooting
• OrbVis vs. NagVis — feature-parity matrix
• Migration from NagVis — what carries over
• Contributing · Code of Conduct · Security policy

Architecture (orientation)

orbvis/
├── backend/          Python 3.12 + FastAPI (async), stdlib sqlite3
├── frontend/         Vue 3 + TypeScript + Vite (Checkmk design system)
├── cmk_plugins/      Checkmk 2.4+ GUI plugins (sidebar, WATO permissions, menu)
├── cmk_plugins_23/   Checkmk 2.3 GUI plugins
├── scripts/          orbvis-setup / orbvis-install wrapper commands (in packages)
├── install.sh        Standalone install/remove (systemd + optional nginx/Apache)
├── install_cmk.sh    Checkmk/OMD install/remove
├── nfpm.yaml         Package definition (.deb/.rpm via nfpm)
└── docker-compose.yml

For backend / frontend / state-pipeline details see docs/architecture.md.

Development

Backend:

cd backend
pip install -e ".[dev]"
cp .env.example .env   # edit as needed; see file for variable reference
uvicorn app.main:app --reload

Frontend:

cd frontend
npm install
npm run dev

Tests:

cd backend  && pytest
cd frontend && npm test

Interactive API docs run at http://localhost:8000/api/docs (or the proxied path in deployed setups, e.g. /<SITE>/orbvis/api/docs inside a Checkmk site). Inside a Checkmk site the docs page requires 2.5+.