chore: polish repo — README badges, CHANGELOG, LICENSE, install.sh cleanup
- README: add shields.io badges, fix stack (Rust, not Node.js), add licensing plan table, improve structure throughout - CHANGELOG: proper Keep a Changelog format, document v0.1.0-alpha - LICENSE: expand source-available terms with clearer restrictions - install.sh: strip licensing/website-api build steps (those run on nixpanel.io/license.nixpanel.io, not on customer servers); add license key prompt + activation against license.nixpanel.io; keep only the panel DB; fix Apache to only expose ports 2083/2087
This commit is contained in:
NixReaper
@@ -1,21 +1,43 @@
|
||||
<div align="center">
|
||||
|
||||
<img src="https://raw.githubusercontent.com/NixReaper/nixpanel/main/assets/logo.png" alt="NixPanel" width="120" />
|
||||
|
||||
# NixPanel
|
||||
|
||||
A modern, open-source web hosting control panel for Linux servers — a free alternative to cPanel/WHM.
|
||||
**A fast, modern web hosting control panel for Linux servers.**
|
||||
Free and open alternative to cPanel/WHM — built in Rust.
|
||||
|
||||
**NixServer** (port 2087) — Server admin panel for managing accounts, DNS, email, databases, SSL, and services.
|
||||
**NixClient** (port 2083) — End-user panel for hosting account holders.
|
||||
[](https://github.com/NixReaper/nixpanel/releases)
|
||||
[](LICENSE)
|
||||
[](https://releases.ubuntu.com/24.04/)
|
||||
[](https://www.rust-lang.org/)
|
||||
[](https://github.com/NixReaper/nixpanel/stargazers)
|
||||
|
||||
[nixpanel.io](https://nixpanel.io) · [Documentation](https://nixpanel.io/docs) · [Pricing](https://nixpanel.io/#pricing) · [Changelog](CHANGELOG.md)
|
||||
|
||||
</div>
|
||||
|
||||
---
|
||||
|
||||
## Overview
|
||||
|
||||
NixPanel gives you everything cPanel/WHM does — without the legacy bloat or the $40/mo price tag.
|
||||
|
||||
| Panel | Port | Purpose |
|
||||
|-------|------|---------|
|
||||
| **NixServer** | `2087` | Server admin — accounts, DNS, mail, SSL, services |
|
||||
| **NixClient** | `2083` | User panel — files, databases, email, domains |
|
||||
|
||||
---
|
||||
|
||||
## Requirements
|
||||
|
||||
| Component | Version |
|
||||
|-----------|---------|
|
||||
| OS | Ubuntu 24.04 LTS |
|
||||
| Architecture | x86_64 |
|
||||
| RAM | 2 GB minimum, 4 GB recommended |
|
||||
| Disk | 20 GB minimum |
|
||||
| Root access | Required |
|
||||
| | |
|
||||
|--|--|
|
||||
| **OS** | Ubuntu 24.04 LTS (x86_64) |
|
||||
| **RAM** | 2 GB minimum · 4 GB recommended |
|
||||
| **Disk** | 20 GB minimum |
|
||||
| **Access** | Root |
|
||||
|
||||
---
|
||||
|
||||
@@ -25,65 +47,87 @@ A modern, open-source web hosting control panel for Linux servers — a free alt
|
||||
bash <(curl -fsSL https://raw.githubusercontent.com/NixReaper/nixpanel/main/install.sh)
|
||||
```
|
||||
|
||||
Or download and inspect first:
|
||||
> The installer is self-updating — it always fetches the latest version before running, so you never need to re-download it manually.
|
||||
|
||||
**Want to inspect before running?**
|
||||
|
||||
```bash
|
||||
curl -fsSL https://raw.githubusercontent.com/NixReaper/nixpanel/main/install.sh -o install.sh
|
||||
less install.sh
|
||||
bash install.sh
|
||||
sudo bash install.sh
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## What Gets Installed
|
||||
|
||||
| Component | Role |
|
||||
|-----------|------|
|
||||
| Apache 2 + PHP-FPM 8.2/8.3 | Web server |
|
||||
| PowerDNS | DNS server |
|
||||
| Exim4 | Mail transfer agent |
|
||||
| Dovecot | IMAP / POP3 server |
|
||||
| MariaDB | Database server |
|
||||
| SpamAssassin | Spam filtering |
|
||||
| Fail2ban | Brute force protection |
|
||||
| Let's Encrypt (certbot) | Free SSL certificates |
|
||||
| NixPanel | Control panel (ports 2083, 2087) |
|
||||
|
||||
---
|
||||
|
||||
## After Installation
|
||||
|
||||
| Panel | URL | Default credentials |
|
||||
|-------|-----|---------------------|
|
||||
| NixServer (admin) | `https://your-ip:2087` | Set during install |
|
||||
| NixClient (user) | `https://your-ip:2083` | Per-account |
|
||||
|
||||
---
|
||||
|
||||
## Updating
|
||||
|
||||
```bash
|
||||
bash /opt/nixpanel/scripts/update.sh
|
||||
```
|
||||
|
||||
Or click **Upgrade Panel** in the NixServer sidebar.
|
||||
| Component | Version | Role |
|
||||
|-----------|---------|------|
|
||||
| Apache 2 + PHP-FPM | 8.2 & 8.3 | Web server with multi-PHP support |
|
||||
| MariaDB | 10.x | Database server (WordPress-compatible) |
|
||||
| PowerDNS | Latest | DNS server |
|
||||
| Exim 4 | Latest | Mail transfer agent |
|
||||
| Dovecot | Latest | IMAP / POP3 server |
|
||||
| SpamAssassin | Latest | Spam filtering |
|
||||
| Fail2ban | Latest | Brute-force protection |
|
||||
| Let's Encrypt | Certbot | Free SSL certificates |
|
||||
| **NixPanel** | Latest | Control panel |
|
||||
|
||||
---
|
||||
|
||||
## Stack
|
||||
|
||||
- **Backend** — Node.js (Fastify), SQLite (panel DB), Prisma ORM
|
||||
- **Frontend** — React 18, Tailwind CSS, Vite
|
||||
- **Auth** — JWT (access + refresh tokens), bcrypt
|
||||
| Layer | Technology |
|
||||
|-------|-----------|
|
||||
| Panel backend | Rust · Axum · SQLx · Tokio |
|
||||
| Database | MariaDB |
|
||||
| Web server | Apache 2 (reverse proxy) |
|
||||
| Auth | JWT · Argon2id |
|
||||
| Frontend | React 18 · TypeScript · Tailwind CSS · Vite |
|
||||
|
||||
---
|
||||
|
||||
## Licensing
|
||||
|
||||
NixPanel uses a **central licensing server** at `license.nixpanel.io`. A license key is required during installation.
|
||||
|
||||
| Plan | Monthly | Annual | Servers |
|
||||
|------|---------|--------|---------|
|
||||
| Free | $0 | $0 | 1 |
|
||||
| Solo | $9.99 | $95.90 | 1 |
|
||||
| Host | $29.99 | $287.90 | 5 |
|
||||
| Agency | $79.99 | $767.90 | Unlimited |
|
||||
|
||||
[Get a license → nixpanel.io](https://nixpanel.io/#pricing)
|
||||
|
||||
---
|
||||
|
||||
## Post-Install
|
||||
|
||||
| Task | Command |
|
||||
|------|---------|
|
||||
| Add SSL | `certbot --apache` |
|
||||
| View logs | `journalctl -u nixpanel -f` |
|
||||
| Restart panel | `systemctl restart nixpanel` |
|
||||
| Update panel | `bash /opt/nixpanel/scripts/update.sh` |
|
||||
|
||||
Access your panels:
|
||||
|
||||
```
|
||||
http://YOUR_IP:2087 ← NixServer (admin)
|
||||
http://YOUR_IP:2083 ← NixClient (users)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Changelog
|
||||
|
||||
See [CHANGELOG.md](CHANGELOG.md) for full version history.
|
||||
See [CHANGELOG.md](CHANGELOG.md) for the full version history.
|
||||
|
||||
---
|
||||
|
||||
## License
|
||||
|
||||
NixPanel is source-available software. See [LICENSE](LICENSE) for details.
|
||||
NixPanel is **source-available** software. You may inspect and self-host under the terms of the [NixPanel License](LICENSE). Redistribution, resale, or offering NixPanel as a managed service is not permitted without a commercial agreement.
|
||||
|
||||
© 2025 NixPanel. All rights reserved.
|
||||
|
||||
Reference in New Issue
Block a user