System Requirements
- ✓ Ubuntu 22.04 / 24.04 or Debian 11 / 12
- ✓ 1 GB RAM minimum (2 GB recommended)
- ✓ 10 GB disk space
- ✓ Root or sudo access
- ✓ Clean server (no existing web server)
Installation
Run the installer script as root:
curl -sSL https://get.pinkerver.com | sudo bash
Or use the manual method:
git clone https://github.com/pinkerver/pinkerver.git
cd pinkerver
sudo bash scripts/install.sh
The installer will:
- 1. Check OS compatibility
- 2. Install Nginx, PHP-FPM, MySQL, and dependencies
- 3. Configure firewall (UFW)
- 4. Set up systemd services
- 5. Start Pinkerver on port 8443
First Login
After installation, open your browser:
https://your-server-ip:8443
You'll be prompted to create an admin account. After that, you can start adding domains, setting up DNS, and configuring your server.
License Activation
Navigate to Settings → License in the panel and enter your license key:
PP-XXXXX-XXXXX-XXXXX-XXXXX
Free licenses are automatically issued. Pro and Beta licenses can be managed from the customer portal.
API Reference
Pinkerver exposes a REST API for automation. All endpoints require JWT authentication.
Phone Home
POST /api/v1/phone-home
{
"license_key": "PP-XXXXX-XXXXX-XXXXX-XXXXX",
"hostname": "server1.example.com",
"ip": "1.2.3.4",
"version": "0.9.9",
"resource_counts": { "domains": 5, "databases": 3 }
}
{
"status": "ok",
"plan": "pro",
"next_check_seconds": 86400
}
Telemetry Upload
POST /api/v1/telemetry
{
"license_key": "PP-XXXXX-...",
"panel_version": "0.9.9",
"events": [
{ "event_type": "panic", "message": "..." }
]
}
{ "received": 1 }