Update README with current features and screenshots
- Cross-platform support (Windows/Linux) with Windows Updates and Winget - Added dependency confirmation workflow and refresh token authentication - New screenshots: History, Live Operations, Windows Agent Details - Local CLI features with terminal output and cache system - Updated known limitations - Proxmox integration is broken - Organized docs to docs/ folder and updated .gitignore - Probably introduced a dozen bugs with Windows agents - stay tuned
This commit is contained in:
50
README.md
50
README.md
@@ -17,9 +17,10 @@ A self-hosted, cross-platform update management platform built with:
|
||||
|
||||
- Go server backend + PostgreSQL
|
||||
- React web dashboard with TypeScript
|
||||
- Linux agents with APT + Docker scanning
|
||||
- Cross-platform agents (Linux APT/DNF/Docker, Windows Updates/Winget)
|
||||
- Local CLI tools for agent management
|
||||
- Update installation system (alpha)
|
||||
- Update installation system with dependency management
|
||||
- Refresh token authentication for stable agent identity
|
||||
|
||||
## What This Isn't
|
||||
|
||||
@@ -32,34 +33,49 @@ A self-hosted, cross-platform update management platform built with:
|
||||
|
||||
### Working Features
|
||||
- Server backend with REST API
|
||||
- Agent registration and check-in
|
||||
- Update discovery for APT packages and Docker images
|
||||
- Update approval workflow
|
||||
- Web dashboard with agent management
|
||||
- Local CLI tools (--scan, --status, --list-updates, --export)
|
||||
- Update installation system (alpha quality)
|
||||
- Cross-platform agent registration and check-in
|
||||
- Update discovery for APT, DNF, Docker images, Windows Updates, and Winget packages
|
||||
- Update approval workflow with dependency confirmation
|
||||
- Web dashboard with agent management and real-time status
|
||||
- Local CLI tools (--scan, --status, --list-updates, --export, --export=json/csv)
|
||||
- Update installation system with dry-run dependency checking
|
||||
- Beautiful terminal output with colors and severity indicators
|
||||
- Local cache system for offline viewing of scan results
|
||||
- Refresh token authentication for stable agent identity
|
||||
- Event-sourced database architecture for scalability
|
||||
|
||||
### Known Limitations
|
||||
- Update installation is minimally tested
|
||||
- DNF/RPM scanner incomplete
|
||||
- No rate limiting on API endpoints
|
||||
- No Windows agent support
|
||||
- No rate limiting on API endpoints (security improvement needed)
|
||||
- No real-time WebSocket updates
|
||||
- Proxmox integration is broken (needs complete rewrite)
|
||||
- Authentication system works but needs security hardening
|
||||
|
||||
## Screenshots
|
||||
|
||||
### Default Dashboard
|
||||

|
||||
Main overview showing agent status, system metrics, and update statistics
|
||||
### Main Dashboard
|
||||

|
||||
Overview showing agent status, system metrics, and update statistics
|
||||
|
||||
### Updates Management
|
||||

|
||||
Comprehensive update listing with filtering, approval, and bulk operations
|
||||
Comprehensive update listing with filtering, approval, and dependency confirmation
|
||||
|
||||
### Agent Details
|
||||

|
||||

|
||||
Detailed agent information including system specs, last check-in, and individual update management
|
||||
|
||||
### Windows Agent Support
|
||||

|
||||
Cross-platform support for Windows Updates and Winget package management
|
||||
|
||||
### History & Audit Trail
|
||||

|
||||
Complete audit trail of all update activities and command execution
|
||||
|
||||
### Live Operations
|
||||

|
||||
Real-time view of update operations with success/failure tracking
|
||||
|
||||
### Docker Container Management
|
||||

|
||||
Docker-specific interface for container image updates and management
|
||||
|
||||
Reference in New Issue
Block a user