diff --git a/README.md b/README.md index 6d30fa0..320edbc 100644 --- a/README.md +++ b/README.md @@ -1,39 +1,83 @@ # Proxmox Unified Console (PUC) πŸš€ -A lightning-fast, unified web dashboard to manage your Proxmox Virtual Environment (PVE), Proxmox Backup Server (PBS), and Proxmox Mail Gateway (PMG) from a single, clean interface. +A lightning-fast, unified web dashboard to manage your **Proxmox Virtual Environment (PVE)**, **Proxmox Backup Server (PBS)**, and **Proxmox Mail Gateway (PMG)** from a single, clean interface. Built entirely with native APIsβ€”no slow iframes, no CORS issues. +--- + ## ✨ Features -* **Unified Multi-Node Management:** Connect multiple PVE, PBS, and PMG instances via API tokens. -* **Proxmox VE (PVE):** - * Live CPU/RAM/Net metrics using Chart.js. - * Start, Stop, Reboot, Delete, and Create VMs & LXC containers. - * Smart NoVNC-Console integration (Popout). - * Hardware & Network config (Resize Disks, add NICs). - * Backup & Snapshot management. -* **Proxmox Backup Server (PBS):** - * Live Datastore capacity monitoring. - * Snapshot explorer with namespace support. - * System jobs overview (Garbage Collection, Prune, Verify). - * Task Log Viewer. -* **Proxmox Mail Gateway (PMG):** - * Unified Spam Quarantine management (Deliver/Delete). - * Cross-node Mail Queue tracking (Active, Deferred, Hold). - * Advanced Syslog Tracking Center. - * Configuration Editor (Relay, Ports, TLS, Trusted Networks, Relay Domains). - * 1-Click SSL Certificate Upload & Management. -* **Task Scheduler:** Built-in cron system to automate VM and Node reboots overnight. -* **Security First:** - * Granular User Roles (Admin, VM-Manager, Viewer). - * Restrict specific VMs to specific users. - * Comprehensive Audit Log tracking all actions. - * Auto-generated Self-Signed SSL out of the box (Port 443). +### πŸ’» Proxmox VE (PVE) +* **Live Metrics:** Real-time CPU, RAM, and Network monitoring using Chart.js. +* **VM / LXC Lifecycle Management:** Start, Stop, Reboot, Delete, and Create Virtual Machines and LXC containers directly from the dashboard. +* **Smart NoVNC-Console:** Seamlessly integrated popout console to bypass Iframe-CORS restrictions. +* **Hardware & Network Config:** Add Network Interfaces (NICs) and expand Virtual Disks on the fly. +* **Backup & Snapshots:** Take snapshots, roll back to previous states, and trigger manual vzdump backups. + +### πŸ’Ύ Proxmox Backup Server (PBS) +* **Live Datastore Monitoring:** Keep track of your storage capacity across all PBS nodes. +* **Snapshot Explorer:** Browse through your backups with full namespace support. +* **System Jobs Overview:** Monitor Garbage Collection, Prune, and Verify tasks. +* **Sync Jobs:** Quick overview of all configured synchronization tasks. +* **Task Log Viewer:** Read PBS task logs directly in your browser. + +### πŸ“§ Proxmox Mail Gateway (PMG) +* **Spam Quarantine:** View, delete, or deliver quarantined emails across all your PMG instances. +* **Mail Queue Tracking:** Inspect Active, Deferred, and Hold Postfix queues. +* **Tracking Center:** Advanced Syslog parser to track email delivery statuses. +* **Configuration Editor:** Manage Default Relays, External/Internal Ports, TLS settings, Trusted Networks, and Relay Domains. +* **SSL Management:** View expiring certificates and deploy new PEM/KEY pairs with a single click. + +### βš™οΈ System & Security +* **Unified Multi-Node Management:** Connect unlimited PVE, PBS, and PMG instances via API tokens. +* **Granular User Roles:** Admin, VM-Manager, and Viewer roles. Restrict specific VMs to specific users. +* **Task Scheduler:** Built-in cron system to automate operations (e.g., node or VM reboots at night). +* **Audit Log:** Comprehensive tracking of all user actions (creation, deletion, configuration changes). +* **Secure by Default:** Auto-generated Self-Signed SSL out of the box (Port 443). + +--- ## πŸ“¦ Quickstart (Docker) +Deploying the Proxmox Unified Console is incredibly easy using Docker. + 1. **Clone the repository:** ```bash - git clone [https://github.com/DEIN_GITHUB_NAME/proxmox-unified-console.git](https://github.com/DEIN_GITHUB_NAME/proxmox-unified-console.git) - cd proxmox-unified-console \ No newline at end of file + git clone [https://github.com/tessmania90/proxmox-unified-console.git](https://github.com/tessmania90/proxmox-unified-console.git) + cd proxmox-unified-console + + Start the container: + Bash + + docker compose up -d --build + + Access the Dashboard: + Open your browser and navigate to: + https://:8443 + (Note: You will need to accept the self-signed certificate warning). + + Default Login: + + Username: admin + + Password: admin + + ⚠️ IMPORTANT: Please change the default password immediately after your first login! + +πŸ› οΈ Architecture + + Backend: PHP 8.2 with a custom, modular API Router (api_pve.php, api_pbs.php, api_pmg.php). + + Database: SQLite (Stored securely in the mapped ./data volume). + + Frontend: Vanilla JavaScript + Tailwind CSS (Zero heavy build steps required). + + Environment: Fully containerized via Docker and docker-compose. + +🀝 Contributing + +Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change. +πŸ“„ License + +MIT \ No newline at end of file