No description
- Go 74.8%
- HTML 16.2%
- JavaScript 6.6%
- Go Template 0.8%
- TypeScript 0.7%
- Other 0.9%
| Filename | Latest commit message | Latest commit date |
|---|---|---|
|
|
||
| .github | ||
| assets | ||
| cmd/compass | ||
| debian | ||
| deploy | ||
| docs | ||
| internal | ||
| tests/e2e | ||
| tools | ||
| .air.toml | ||
| .dockerignore | ||
| .gitignore | ||
| .golangci.yaml | ||
| compass.yaml | ||
| Dockerfile | ||
| go.mod | ||
| go.sum | ||
| LICENSE | ||
| Makefile | ||
| package-lock.json | ||
| package.json | ||
| playwright.config.ts | ||
| README.md | ||
| zensical.toml | ||
A landing page for your services, dashboards, and documents, discovered automatically from sources such as Docker, Kubernetes, and Tailscale.
Getting started · Docs · Demo
Why Compass
Add a source and Compass renders what is exposed in a server-driven UI with source status, tags, metadata, and operator context. Search, filter, debug, and jump into services without maintaining a pile of hand-written cards.
- Docker, Kubernetes, Tailscale, Headscale, static config, and JSON API sources.
- Source health, refresh status, service metadata, panels, tags, and debug views.
- Server-rendered HTML with HTMX, Alpine.js, Tailwind, and daisyUI.
Quick start
Docker source compass.yaml:
organization:
name: Homelab
services:
sources:
- type: docker
name: local
# Add the host's docker GID so the non-root container user can read the socket. Alternatively use: tecnativa/docker-socket-proxy
docker run --rm -p 8080:8080 \
--group-add $(getent group docker | cut -d: -f3) \
-v /var/run/docker.sock:/var/run/docker.sock:ro \
-v $PWD/compass.yaml:/etc/compass/compass.yaml:ro \
adinhodovic/compass:latest \
-c /etc/compass/compass.yaml
Kubernetes source compass.yaml:
organization:
name: Homelab
services:
sources:
- type: kubernetes
name: cluster # Helm grants in-cluster RBAC for discovery
kubernetes:
namespaces: []
helm install compass oci://ghcr.io/adinhodovic/charts/compass -n compass --create-namespace --set-file config=compass.yaml
See Getting started for a minimal config and source examples.