Skip to content

log-forge/unicron-source

Repository files navigation

LogForge Unicron

LogForge Unicron is Open Source code from https://github.com/log-forge/logforge for a local-first observability appliance for Docker hosts and container fleets. It packages a web UI, Central API, local admin auth, agent enrollment, telemetry ingest, alert evaluation, and notifications into a standalone deployment.

Quick Start

Run the standalone appliance:

docker compose -f deploy/standalone/docker-compose.yml up -d

Open:

https://localhost/unicron

If CENTRAL_ADMIN_PASSWORD is unset, the auth service generates a first-boot administrator password and logs it once:

docker logs unicron-appliance | grep -E "Local admin first-boot generated administrator credential|generatedPassword"

To validate a local appliance image:

docker build -f ops/appliance/Dockerfile -t unicron-appliance:latest .

UNICRON_IMAGE=unicron-appliance:latest \
UNICRON_HTTP_PORT=8080 \
UNICRON_HTTPS_PORT=8444 \
UNICRON_MTLS_PORT=9443 \
docker compose -f deploy/standalone/docker-compose.yml up -d

What Is Included

  • Single-image appliance runtime for standalone deployment.
  • Local administrator auth with explicit recovery mode.
  • Central backend, React frontend, alert engine, notifier API, and notifier worker.
  • Postgres, MongoDB, Redis, Step CA/RA, Traefik, VictoriaMetrics, VictoriaLogs, and OTel collector inside the appliance.
  • Agent enrollment through tokens and mTLS identity.
  • Browser and API ingress under /unicron.
  • Agent mTLS and OTLP ingress on port 8443.

Repository Map

  • deploy/standalone/: standalone Compose artifact.
  • ops/appliance/: appliance Dockerfile, manager, templates, and tests.
  • central/unicron/backend/: Central FastAPI backend.
  • central/unicron/frontend/: React Router frontend.
  • central/auth/: local administrator auth service.
  • edge/go-streamer/: remote agent.
  • services/alert-engine/: alert rules and evaluation service.
  • services/notifier/: notification API and worker.
  • libs/unicron_shared/: shared Python models and enums.

Development

Useful commands:

make build-appliance
make build-up
make central-up
make central-down
make dind-up
make dind-down

Common focused checks:

docker compose -f deploy/standalone/docker-compose.yml config
npm --prefix central/unicron/frontend run typecheck
TMPDIR=/tmp npm --prefix central/unicron/frontend test
npm --prefix central/auth run typecheck
make test-central-auth
(cd ops/appliance/manager && go test ./...)
(cd edge/go-streamer && go test ./...)
(cd central/unicron/backend && poetry run python -m unittest tests.test_security_hardening tests.test_origin_policy tests.test_appliance_update)

Contributing

See CONTRIBUTING.md.

Security

See SECURITY.md.

License

LogForge Unicron is Open Source. See LICENSE.

About

No description, website, or topics provided.

Resources

License

Contributing

Security policy

Stars

0 stars

Watchers

0 watching

Forks

Releases

No releases published

Packages

 
 
 

Contributors