Web Interface
This guide covers how to use the Konarr web interface to monitor your containers, view SBOMs, manage projects, and track security vulnerabilities.
Frontend Implementation: The web interface is built with Vue.js 3 and TypeScript. Views are located in src/views and components in src/components.
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:
- Session Authentication - Login through the web interface to obtain session cookies
- Admin Access - Required for server settings, user management, and advanced features
- 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
See the Projects documentation for detailed information on project management and the project view.
📸 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
See the Dependencies and SBOMs documentation for detailed information on snapshots and dependency tracking.
🚨 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
See the Security Alerts documentation for comprehensive alert management information.
👤 User Profile
- Purpose: Personal account management and settings
- Contents:
- View account details (username, role, status)
- Password management with strength validation
- Active session management
- Account creation date and last login information
- Access: Available to all authenticated users
⚙️ Settings / Admin
- Purpose: Server-level configuration and administration (admin-only)
- Contents:
- User and token management with enhanced UI
- Agent authentication settings
- Server configuration
- System health and statistics
- Access: Requires admin privileges
User Profile Management
Accessing Your Profile
Navigate to your profile page from the navigation menu:
- Location: User menu in the top navigation bar
- Access: Available to all authenticated users
- URL:
/profile
Profile Information
View and manage your account details:
- Username: Your unique account identifier
- Role: Your assigned role (Admin or User)
- Status: Account state (Active, Inactive, Suspended)
- Created At: Account creation timestamp
- Last Login: Most recent login time
- Avatar: Profile picture (if configured)
Password Management
Change your password securely through the profile page:
- Enter Current Password: Authenticate the change request
- Set New Password: Must be at least 8 characters
- Confirm Password: Verify new password entry
- Password Strength: Real-time validation shows password strength
- Submit: Update your password
Security Notes:
- Passwords must be at least 8 characters long
- Strong passwords are recommended (mix of letters, numbers, symbols)
- Changing password will not log out active sessions immediately
Session Management
View and monitor your active sessions:
- Active Sessions: List of currently authenticated sessions
- Session Details: Login time, device/browser information
- Session Security: Review unusual or unexpected sessions
For session management and security, see the Security Guide.
Projects Management
For detailed information on creating, organizing, and managing projects, see the Projects documentation.
Key features include:
- Manual and automatic project creation
- Project types (Container, Group, Application, Server)
- Project hierarchy and organization
- Setup workflows for agents and SBOM uploads
Dependencies and Snapshots
For detailed information on viewing and managing SBOMs and dependencies, see the Dependencies and SBOMs documentation.
Key features include:
- Understanding snapshots and SBOM data
- Dependency navigation and search
- SBOM standards (CycloneDX, SPDX)
- Manual SBOM upload
- Integration with scanning tools
Security Alerts
For detailed information on managing security alerts and vulnerabilities, see the Security Alerts documentation.
Key features include:
- Alert overview and lifecycle
- Filtering and bulk operations
- Alert details and remediation guidance
- Integration with vulnerability scanners
Settings and Administration
User Management
Admin users can manage system access with an enhanced interface:
- User Accounts: Create and manage user accounts with improved UI
- Role Assignment: Assign admin or standard user privileges
- Status Management: Activate, deactivate, or suspend user accounts
- User Search: Find users quickly with search and filtering
- Pagination: Navigate through large user lists efficiently
- Session Management: Monitor active sessions and access logs
- Bulk Operations: Manage multiple users efficiently
The updated admin interface provides better visibility and control over user accounts, with real-time statistics showing total, active, and inactive user counts.
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
- Start Server: Launch Konarr server and access web interface
- Admin Login: Log in with admin credentials
- Configure Settings: Set up agent tokens and server configuration
- Setup Profile: Optionally configure your user profile and password
- Agent Setup: Configure and deploy agents to monitor containers or upload SBOMs manually
Daily Operations
- Monitor Projects: Review project status and recent snapshots
- Browse Dependencies: Navigate through dependency lists with pagination
- Review Alerts: Triage new security vulnerabilities
- Investigate Issues: Drill down into specific snapshots and dependencies
- Take Action: Update containers, acknowledge alerts, or escalate issues
Ongoing Management
- Trend Analysis: Monitor security trends across projects
- Compliance Reporting: Export SBOMs for compliance requirements
- System Maintenance: Review server health and performance metrics
- User Management: Manage access and permissions as team grows (admin only)
- Profile Updates: Keep passwords current and review active sessions
Navigation Tips
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
- URL Parameters: Pagination states are preserved in URLs for sharing
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
- URL Sync: Page numbers persist in URLs for seamless navigation
- 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:
- Check server is running:
curl http://localhost:9000/api/health - Verify frontend configuration in server settings
- Clear browser cache and cookies
- Check network connectivity and firewall settings
Authentication Problems:
- Verify admin user account exists
- Check session timeout settings
- Clear browser cookies and re-login
- Verify server authentication configuration
Performance Issues:
- Check server resource usage (CPU, memory, disk)
- Review database performance and size
- Consider implementing reverse proxy caching
- Monitor network latency and bandwidth
Additional Help
For more troubleshooting information:
- Troubleshooting Guide - Comprehensive troubleshooting procedures
- Configuration Guide - Server and web interface configuration
- Security Setup - Authentication and security configuration
Next Steps
After familiarizing yourself with the web interface:
- Projects - Detailed project management and project view
- Security Alerts - Managing security vulnerabilities
- Dependencies - Understanding SBOMs and dependency tracking
- User Profile - Manage your account and password settings
- CLI Usage - Learn about command-line operations
- API Documentation - Integrate with external systems
- Security Configuration - Implement production security practices