NexusPanel Documentation
Complete guides for installing, configuring, and using every NexusPanel feature — plus the full API reference, architecture deep-dives, and screen guides.
Feature Guides
Every module NexusPanel ships with, grouped by area.
📊 System & Monitoring
Dashboard
Real-time CPU, RAM, disk and network charts, service health grid, quick stats and reboot.
Process Manager
Live process list with 5s refresh, color-coded CPU/MEM thresholds and kill by PID.
Service Manager
Full systemd control — start, stop, restart, enable, disable and detailed status.
Log Viewer
Browse /var/log with split-pane tailing and full-text search.
System Updates
Check and apply dnf/apt updates with live streaming progress and security filter.
📁 Files & Access
File Manager
Browse, upload, edit, archive and search files with Ace editor, bin/trash and conflict detection.
Terminal
Interactive web terminal via xterm.js + WebSocket + node-pty, with tabs, presets and auto-reconnect.
FTP Accounts
vsftpd account management — create, enable, disable, delete and set home directories.
🗄️ Databases & Mail
PostgreSQL Manager
Tables, schemas, views and functions with inline SQL editor, EXPLAIN ANALYZE, import and export.
Email Manager
Create accounts with quotas, webmail inbox, rich-text compose, reply and forward.
🌐 Containers & Web
Docker
Container and image management with Compose project grouping and live logs.
Domains
Nginx virtual host manager with live config editor and subdomain support.
SSL Certificates
Let's Encrypt via certbot with expiry badges, bulk renew and dry-run testing.
PHP-FPM Manager
Pool management with OPcache stats, modules, config editor and graceful reload.
🛡️ Security & Automation
Firewall Rules
Multi-backend firewall (firewalld, ufw, nftables, iptables) with zones, templates and live stats.
Virus Scanner
ClamAV-powered scans with quarantine, restore/delete and freshclam updates.
Backups
File, directory and full-system targets with PostgreSQL dumps, progress and retention policies.
Cron Jobs
Crontab editor per system user with validation, presets and next-run calculation.
Alerts
Proactive alert configuration and rules so you know before it breaks.
⚙️ Operations & Control
Audit Trail
Every mutation auto-logged with user, method, path and IP — searchable and exportable.
Notifications
In-app bell with unread badges and a programmatic notification API.
MIME Types
Browse 2,148+ system types with search, distribution charts and custom CRUD.
Settings
Panel control center — API tokens, system info, health checks and maintenance.
Profile
Avatar, display name, TOTP 2FA with QR code, session management and activity log.
Users
System user management with bulk operations.
API Tokens
Create and revoke bearer tokens for automation.
Search
Global cross-module search across the entire panel.
Start Here
Installation Guide
Install NexusPanel on your VPS in 5 minutes. Includes prerequisites, install script walkthrough, and first-time setup.
Maintenance Scripts
Troubleshoot, logs, error checklist, health monitoring, update, and uninstall scripts.
API Reference
Complete REST API documentation for all 6 route modules.
Architecture
How NexusPanel works under the hood — auth, security, data storage, deployment, and WebSockets.
Screen Guides
User-facing walkthroughs of every screen in the application.
Knowledge Base
Guides for purchasing, installing, and troubleshooting NexusPanel.