myron/novacpx
1
0
Fork 0
mirror of https://github.com/myronblair/novacpx synced 2026-06-30 17:50:41 -05:00
Code Issues Packages Projects Releases Wiki Activity

Update documentation with all current features and services

Browse Source 
- README: full feature matrix (hosting, DNS, email, databases, files, SSL, security, Docker,
  monitoring, update channels/versioning, reseller branding, settings, API)
- Admin guide: update channels section with stable/beta table; Settings section now documents
  all DB-backed fields including update channel
- User guide: email domain dropdown note

Co-Authored-By: Claude Sonnet 4.6 <noreply@anthropic.com>
This commit is contained in:
Myron Blair
2026-06-09 23:10:19 +00:00
parent 95cc4914cd
commit 7367fe658c
3 changed files with 140 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/README.md
+116 -16
View File
@@ -1,24 +1,124 @@
# NovaCPX Documentation # NovaCPX — Documentation
NovaCPX is an open-source Linux web hosting control panel with three-tier management (Admin → Reseller → User). NovaCPX is a full-featured open-source Linux web hosting control panel. It replaces cPanel/Plesk with a modern three-tier architecture (Admin → Reseller → End User), runs entirely on your own server, and has no per-account licensing fees.
## Documents ---
| Guide | Audience | Description | ## Feature Overview
|-------|----------|-------------|
| [Installation Guide](install.md) | Server admins | Requirements, installer usage, file layout, auto-deploy setup |
| [Admin Guide](admin-guide.md) | Server admins | All admin panel features: accounts, DNS, mail, security, Docker, notifications |
| [Reseller Guide](reseller-guide.md) | Resellers | Creating and managing customer accounts, white-label branding |
| [User Guide](user-guide.md) | End users | Files, email, databases, FTP, DNS, SSL, cron, Docker |
| [API Reference](api-reference.md) | Developers | Full REST API documentation for all endpoints |
## Quick links ### Hosting Management
- **Multi-account architecture** — Admin, Reseller, and User tiers with strict isolation
- **Hosting packages** — disk, email, database, FTP, domain, and subdomain quotas per plan
- **Per-account PHP version** — PHP 7.4, 8.1, 8.2, 8.3 via PHP-FPM pools; custom php.ini overrides
- **Wildcard vhost support** — Apache and Nginx backends; per-account vhost files auto-generated
- **Account suspend / unsuspend** — disables vhost and notifies the account holder
- **WHMCS billing bridge** — provision, suspend, terminate, and change packages from WHMCS automatically
- Admin panel: `https://<server>:8882` ### Domains & DNS
- Reseller panel: `https://<server>:8881` - **Addon domains, subdomains, redirects** — unlimited per account (within package limits)
- User panel: `https://<server>:8880` - **Full DNS manager** — BIND9 or PowerDNS backend; A, AAAA, CNAME, MX, TXT, NS, SRV, CAA records
- Webmail: `https://<server>:8883` - **Nameserver health checker** — verify NS1/NS2 resolve correctly after setup
- **Auto-provisioning** — DNS zone, vhost, and Linux user created automatically at account creation
### Email
- **Virtual mailboxes** — Postfix + Dovecot backend; SHA-512 hashed passwords; Maildir storage
- **IMAP/SMTP access** — IMAP :993 SSL/TLS, SMTP :587 STARTTLS
- **Webmail (Roundcube)** — built-in at port 8883 with single sign-on (SSO) from user panel
- **DKIM signing** — auto-provisioned per domain; OpenDKIM wired into Postfix milter
- **SPF/DMARC records** — added to DNS zone automatically on account creation
- **Optional Rspamd** — postfix-dovecot-rspamd stack available in Server Options
- **Domain dropdown** — email creation UI shows selectable domain list (no typos)
### Databases
- **MySQL / MariaDB** — per-account databases with isolated users; phpMyAdmin link
- **PostgreSQL** — optional; pgAdmin link when installed
### File Management
- **In-browser file manager** — browse, create, edit, upload, download, rename, delete, chmod
- **Path sandboxing** — users cannot access files outside their home directory
- **FTP accounts** — ProFTPD, vsftpd, or PureFTPD (swappable in Server Options); explicit TLS
### SSL Certificates
- **Let's Encrypt (Certbot)** — free certificates issued and auto-renewed per domain
- **Certificate status dashboard** — days remaining, expiry alerts at ≤14 days
- **Self-signed fallback** — panel runs on a self-signed cert with correct IP SAN by default
### Security
- **Fail2Ban** — 5 active jails: SSH, panel auth, API abuse, PHP errors, Postfix SMTP
- **UFW firewall manager** — allow/deny rules by port, protocol, and source IP from admin panel
- **API rate limiting** — 10 req/min on auth, 120 req/min on API; 429 with Retry-After header
- **Two-factor authentication (TOTP)** — admin/reseller login; admin can reset any user's 2FA
- **Session management** — view and revoke active sessions per user
- **Audit log** — every API action logged with user, IP, payload; filterable by user/action/date
### Docker
- **Docker Engine management** — install from panel; container/image/volume/network CRUD
- **Compose stacks** — create from YAML, start/stop/remove, live streaming logs
- **One-click app catalog** — 9 templates: WordPress, Ghost, Nextcloud, Gitea, Matomo, Vaultwarden, Node.js, Flask, Static Nginx
- **Per-user quotas** — admin sets max containers, CPU, and RAM per account
- **Reseller allocation** — resellers configure Docker limits for their own customers
- **Async launch** — image pulls run in background so PHP never times out
### Server Monitoring
- **Real-time stats** — CPU, RAM, disk, uptime on admin dashboard (polled via API)
- **Historical charts** — Chart.js graphs of CPU and RAM over time (5-minute cron samples)
- **Service health** — Apache/Nginx/MySQL/Postfix/Dovecot/FTP/DNS status with restart controls
- **JARVIS integration** — optional agent sends live metrics to the JARVIS AI dashboard
### Updates & Versioning
- **Update channels** — **Stable** (main branch, major/minor releases) or **Beta** (beta branch, patch/pre-release)
- **One-click update** — `git pull` → PHP syntax check → deploy → auto-restore if panel goes down
- **Version history** — every deploy recorded with version number, commit hash, and timestamp
- **Nightly cache** — update checks cached for 12 hours; nightly cron pre-warms cache at 2am
- **OS upgrades** — `apt-get upgrade` with pre-backup, service health check, and live log streaming
- **GitHub Actions** — pushes to `main` auto-bump PATCH version; pushes to `beta` auto-append `-beta.N`
### Reseller Features
- **White-label branding** — custom logo upload (PNG/SVG), accent color picker with live preview, custom CSS, support email/URL, hide "Powered by" toggle
- **Customer account CRUD** — create, suspend, unsuspend, terminate customer accounts
- **Docker quota management** — per-customer container/CPU/RAM limits
- **Strict isolation** — resellers only see their own accounts
### Panel Configuration
- **Settings page** — panel name, default PHP version, nameservers, update channel; all values loaded from DB, saved individually
- **Server Options** — swap web/mail/FTP/DNS backends without touching config files
- **Notifications** — CyberMail API for welcome emails, suspension notices, disk warnings, SSL expiry; test button in panel
- **Backups** — per-account file + database backup; download or restore; optional rclone/S3 remote destination
- **Cloudflare integration** — per-account API key; sync DNS records, toggle CDN proxy per record
- **Nginx Proxy Manager** — Docker-based reverse proxy for additional services
### Developer / Automation
- **REST API** — 25+ endpoints; all documented in [api-reference.md](api-reference.md)
- **Bearer token auth** — create API tokens for scripts and integrations
- **WHMCS module** — full billing bridge for automated provisioning
- **Auto-deploy webhook** — GitHub push → webhook → git pull + PHP syntax check + DB migrations
- **SQLite database** — no MySQL required for the panel itself; survives database server restarts
---
## Panels
| Panel | Port | Audience |
|-------|------|----------|
| Admin | 8882 | Server administrators |
| Reseller | 8881 | Reseller accounts |
| User | 8880 | End-user hosting accounts |
| Webmail (Roundcube) | 8883 | Email users (SSO from user panel) |
---
## Documentation
| Guide | Audience |
|-------|----------|
| [Installation Guide](install.md) | Server admins — requirements, installer, auto-deploy setup |
| [Admin Guide](admin-guide.md) | Full admin panel feature reference |
| [Reseller Guide](reseller-guide.md) | Reseller account and branding management |
| [User Guide](user-guide.md) | End-user features: files, email, databases, Docker, etc. |
| [API Reference](api-reference.md) | Full REST API with auth, rate limits, and all endpoints |
---
## Source ## Source
GitHub: [myronblair/novacpx](https://github.com/myronblair/novacpx) GitHub: [myronblair/novacpx](https://github.com/myronblair/novacpx) (private)
docs/admin-guide.md
+21 -2
View File
@@ -139,7 +139,18 @@ View all active login sessions. Revoke individual sessions or all sessions for a
### Updates ### Updates
Check for newer NovaCPX versions on GitHub. If an update is available, click **Update Now** — this runs `git pull` on the server and triggers a deploy. Check for NovaCPX and OS updates. Results are cached for 12 hours so the page loads instantly; click **↻ Refresh now** to force a live check.
**Update channels** (set in Settings):
| Channel | GitHub branch | Versioning |
|---------|--------------|------------|
| Stable | `main` | Major/minor releases (e.g. 1.1.0) |
| Beta | `beta` | Patch and pre-release (e.g. 1.1.1-beta.3) |
The Updates page shows your installed version, the latest available version for your channel, and pending commits. Click **Update NovaCPX** to pull and deploy. PHP syntax is validated before deploy; if the panel goes down after update it auto-restores from a backup.
**OS Upgrade** streams `apt-get upgrade` output in real time. A backup of the web root is made before upgrading.
### Backups ### Backups
@@ -190,7 +201,15 @@ Notification triggers:
### Settings ### Settings
Panel-wide settings: panel name, default PHP version, nameservers, update channel. Panel-wide settings. All values are loaded from the database when the page opens and saved individually.
| Setting | Description |
|---------|-------------|
| Panel Name | Name shown in the browser title and sidebar |
| Default PHP Version | PHP version applied to new accounts (7.4, 8.1, 8.2, 8.3) |
| Primary Nameserver | NS1 hostname shown to users when setting up DNS |
| Secondary Nameserver | NS2 hostname |
| Update Channel | **Stable** (main branch) or **Beta** (beta branch) — controls which GitHub branch the Updates page checks and deploys from |
## WHMCS Billing Bridge ## WHMCS Billing Bridge
docs/user-guide.md
+3 -1
View File
@@ -61,7 +61,9 @@ Files outside your home directory cannot be accessed.
### Creating a mailbox ### Creating a mailbox
Click **Add Email Account**. Enter the local part (the part before `@`), select the domain, and set a password. An optional storage quota limits how much mail the mailbox can hold. Click **Add Email Account**. Enter the local part (the part before `@`) in the text field, then select your domain from the dropdown. Set a password. An optional storage quota limits how much mail the mailbox can hold.
Only domains on your account appear in the dropdown, preventing typos in the address.
### Accessing your email ### Accessing your email