Web Interface

This guide covers how to use the Konarr web interface to monitor your containers, view SBOMs, manage projects, and track security vulnerabilities.

Accessing the Web Interface

Basic Access

Open the server URL in your browser (default port 9000):

http://<konarr-host>:9000

Examples:

  • Local development: http://localhost:9000
  • Network deployment: http://your-server-ip:9000
  • Custom domain: https://konarr.example.com

Behind Reverse Proxy

If the server is behind a reverse proxy or load balancer, use the external HTTPS URL configured in server.frontend.url.

For reverse proxy setup, see the Reverse Proxy Setup Guide.

Authentication

The web interface uses session-based authentication:

  1. Session Authentication - Login through the web interface to obtain session cookies
  2. Admin Access - Required for server settings, user management, and advanced features
  3. User Access - Standard access for viewing projects, snapshots, and alerts

Main Interface Areas

The Konarr web interface is organized into several main sections:

📁 Projects

  • Purpose: Logical groups representing hosts, applications, or container clusters
  • Contents: Each project contains snapshots, SBOMs, and security data
  • Features:
    • Project hierarchy (parent/child relationships)
    • Project types: Containers, Groups, Applications, Servers
    • Status indicators (online/offline)
    • Search and filtering capabilities

📸 Snapshots

  • Purpose: Captured states of containers or systems at specific points in time
  • Contents: SBOM data, dependency information, vulnerability scan results
  • Features:
    • Click snapshots to view detailed SBOM and vulnerability summaries
    • Comparison between different snapshot versions
    • Metadata including scan tools used, timestamps, and container information

🚨 Alerts

  • Purpose: Security vulnerability alerts generated from scans
  • Contents: Vulnerability details, severity levels, affected components
  • Features:
    • Severity filtering (Critical, High, Medium, Low)
    • Alert state management (Vulnerable, Acknowledged, Secure)
    • Search and filtering by CVE, component, or description
    • Bulk operations for alert management

⚙️ Settings / Admin

  • Purpose: Server-level configuration and administration (admin-only)
  • Contents:
    • User and token management
    • Agent authentication settings
    • Server configuration
    • System health and statistics
  • Access: Requires admin privileges

Projects Management

Creating Projects

Projects can be created in two ways:

  1. Manual Creation: Through the web interface (admin required)
  2. Auto-Creation: Agents can automatically create projects when configured with agent.create: true

Project Types

  • Container: Individual container projects
  • Group: Collections of related projects (e.g., microservices)
  • Application: Application-specific projects
  • Server: Host-level projects

Project Features

  • Hierarchy: Projects can have parent-child relationships for organization
  • Search: Use the search/filter box to find specific projects by name, tag, or hostname
  • Status: Visual indicators show project health and last update status
  • Statistics: View snapshot counts, vulnerability summaries, and last scan times

Snapshots and SBOMs

Understanding Snapshots

Snapshots represent the state of a container or system at a specific time:

  • Automatic Creation: Generated when agents scan containers
  • Manual Triggers: Can be triggered through the API or agent commands
  • Versioning: Multiple snapshots per project show changes over time

Viewing SBOM Details

Click on any snapshot to access detailed information:

  • Dependencies: Complete list of packages, libraries, and components
  • Vulnerability Data: Security scan results and risk assessments
  • Metadata: Scan tool information, timestamps, and container details
  • Export Options: Download SBOM data in various formats (JSON, XML)

SBOM Standards

Konarr uses industry-standard SBOM formats:

  • CycloneDX: Primary format for SBOM generation and storage
  • SPDX: Alternative format support
  • Tool Integration: Works with Syft, Grype, Trivy, and other scanning tools

Security Alerts

Alert Overview

Security alerts are automatically generated from vulnerability scans:

  • Source: Generated from tools like Grype and Trivy
  • Severity Levels: Critical, High, Medium, Low, Unknown
  • Real-time Updates: Alerts update as new snapshots are created

Alert Management

  • Filtering: Filter by severity, state, search terms, or CVE IDs
  • State Management: Mark alerts as Acknowledged or Secure
  • Bulk Operations: Handle multiple alerts simultaneously
  • Triage Workflow: Use alerts to prioritize security remediation

Alert Details

Each alert provides comprehensive information:

  • Vulnerability Description: Detailed CVE information and impact
  • Affected Components: Which packages/dependencies are vulnerable
  • Severity Assessment: Risk level and CVSS scores where available
  • Remediation: Version upgrade recommendations and fix information

Settings and Administration

User Management

Admin users can manage system access:

  • User Accounts: Create and manage user accounts
  • Role Assignment: Assign admin or standard user privileges
  • Session Management: Monitor active sessions and access logs

Agent Token Management

Configure agent authentication:

  • Token Generation: Server auto-generates agent tokens on first startup
  • Token Retrieval: Access current agent token through admin interface
  • Token Security: Rotate tokens for enhanced security

Server Configuration

Access server-level settings:

  • Network Configuration: Domain, port, and proxy settings
  • Security Settings: Authentication, secrets, and access controls
  • Feature Toggles: Enable/disable specific Konarr features
  • Performance Settings: Database cleanup, retention policies

Typical Workflow

Initial Setup

  1. Start Server: Launch Konarr server and access web interface
  2. Admin Login: Log in with admin credentials
  3. Configure Settings: Set up agent tokens and server configuration
  4. Agent Setup: Configure and deploy agents to monitor containers

Daily Operations

  1. Monitor Projects: Review project status and recent snapshots
  2. Review Alerts: Triage new security vulnerabilities
  3. Investigate Issues: Drill down into specific snapshots and dependencies
  4. Take Action: Update containers, acknowledge alerts, or escalate issues

Ongoing Management

  1. Trend Analysis: Monitor security trends across projects
  2. Compliance Reporting: Export SBOMs for compliance requirements
  3. System Maintenance: Review server health and performance metrics
  4. User Management: Manage access and permissions as team grows

Search and Filtering

  • Global Search: Use the search box on Projects and Snapshots pages
  • Filter Options: Filter by project type, status, severity, or date ranges
  • Quick Access: Bookmark frequently accessed projects for easy navigation

Keyboard Shortcuts

  • Navigation: Use browser back/forward for quick page navigation
  • Refresh: F5 or Ctrl+R to refresh data views
  • Search: Click search boxes or use Tab navigation

Performance Optimization

  • Pagination: Large datasets are automatically paginated for performance
  • Lazy Loading: Detailed data loads on-demand when viewing specific items
  • Caching: Web interface caches frequently accessed data

Export and Automation

Manual Export

Export data directly from the web interface:

  • SBOM Export: Download complete SBOM data from snapshot detail pages
  • Vulnerability Reports: Export security scan results
  • Project Data: Export project summaries and statistics

API Integration

For automation and integration:

  • REST API: Complete API access for all web interface functionality
  • Authentication: Use session cookies for web-based API access
  • Documentation: See API Documentation for complete endpoint reference

Reporting

Generate reports for compliance and management:

  • Security Summaries: Aggregate vulnerability data across projects
  • Compliance Reports: SBOM data for regulatory requirements
  • Trend Analysis: Historical data for security and dependency trends

Troubleshooting

Common Issues

Web Interface Not Loading:

  1. Check server is running: curl http://localhost:9000/api/health
  2. Verify frontend configuration in server settings
  3. Clear browser cache and cookies
  4. Check network connectivity and firewall settings

Authentication Problems:

  1. Verify admin user account exists
  2. Check session timeout settings
  3. Clear browser cookies and re-login
  4. Verify server authentication configuration

Performance Issues:

  1. Check server resource usage (CPU, memory, disk)
  2. Review database performance and size
  3. Consider implementing reverse proxy caching
  4. Monitor network latency and bandwidth

Additional Help

For more troubleshooting information:

Next Steps

After familiarizing yourself with the web interface: