Introduction
Konarr is a blazing fast, lightweight web interface for monitoring your servers, clusters, and containers' supply chains for dependencies and vulnerabilities. Written in Rust 🦀, it provides minimal resource usage while delivering real-time insights into your software bill of materials (SBOM) and security posture.
Key Features
- Simple, easy-to-use web interface with both light and dark modes
- Blazing fast performance with minimal resource usage (written in Rust 🦀)
- Real-time container monitoring using industry-standard scanners:
- Orchestration support for:
- Docker / Podman
- Docker Compose / Docker Swarm
- Kubernetes support (planned 🚧)
- Software Bill of Materials (SBOM) generation and management for containers
- Supply chain attack monitoring (in development 🚧)
- CycloneDX support (v1.5 and v1.6) for SBOM formats
Architecture
Konarr follows a simple server + agent architecture:
-
Server: Built with Rust and the Rocket framework
- Provides REST API and web UI
- Uses SQLite for lightweight data storage (GeekORM for database operations)
- Stores server settings including agent authentication keys
- Serves frontend built with Vue.js and TypeScript
- Default port: 9000
-
Agent / CLI: Rust-based CLI (
konarr-cli
) that: -
Extensible tooling:
- Tool discovery and management system
- Support for multiple package managers:
- Standardized SBOM and vulnerability report uploading
Technologies Used
Konarr is built with modern, high-performance technologies:
Backend:
- Rust using Rocket framework for the web server
- GeekORM for database operations and SQLite integration
- Figment for configuration management
- Tokio for asynchronous runtime
Frontend:
- Vue.js 3 with TypeScript for reactive UI
- Tailwind CSS for responsive styling
- Vite for fast development and building
- Material Design Icons (MDI) and Heroicons for UI icons
- HeadlessUI for accessible UI components
Database:
- SQLite for lightweight, embedded data storage
- GeekORM for type-safe database operations
- Automatic migrations and schema management
Security & Standards:
- CycloneDX (v1.5 and v1.6) for SBOM format compliance
- Session-based authentication for web UI
- Bearer token authentication for agents
- CORS support for API access
Container & Deployment:
- Docker and Podman support
- Docker Compose configurations
- Kubernetes support (planned)
- Multi-architecture container images (x86_64, ARM64)
Quick Links
- Installation & Setup
- Server Setup
- Agent Setup
- Configuration & Usage
- API Documentation
- Security
- API Documentation
- Security
Getting Started
- Install the Server - See Server Installation
- Configure Authentication - Retrieve the agent token from the server
- Deploy Agents - See Agent Installation to monitor your containers
- Monitor Projects - View SBOMs and vulnerabilities in the web interface
For a quick start using Docker, see our installation guide.
Project Repository: https://github.com/42ByteLabs/konarr
Frontend Repository: https://github.com/42ByteLabs/konarr-client
Container Images: Available on GitHub Container Registry
License: Apache 2.0