https://github.com/log-forge/unicron-source
https://github.com/log-forge/unicron-source
Last synced: 26 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/log-forge/unicron-source
- Owner: log-forge
- License: other
- Created: 2026-05-30T09:16:23.000Z (26 days ago)
- Default Branch: main
- Last Pushed: 2026-05-30T09:26:48.000Z (26 days ago)
- Last Synced: 2026-05-30T11:15:51.612Z (26 days ago)
- Language: Python
- Size: 1.29 MB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# LogForge Unicron
LogForge Unicron is source-available 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:
```sh
docker compose -f deploy/standalone/docker-compose.yml up -d
```
Open:
```text
https://localhost/unicron
```
If `CENTRAL_ADMIN_PASSWORD` is unset, the auth service generates a first-boot
administrator password and logs it once:
```sh
docker logs unicron-appliance | grep -E "Local admin first-boot generated administrator credential|generatedPassword"
```
To validate a local appliance image:
```sh
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:
```sh
make build-appliance
make build-up
make central-up
make central-down
make dind-up
make dind-down
```
Common focused checks:
```sh
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](CONTRIBUTING.md).
## Security
See [SECURITY.md](SECURITY.md).
## License
LogForge Unicron Proprietary License. See [LICENSE](LICENSE).