QuickBox Pro is a complete media server management system featuring 60+ applications, a professional dashboard, CLI tools, and multi-user support.

---

Table of Contents

• Quick Install
• Supported Operating Systems
• Where to Get Your API Key
• CLI Options
• Step-by-Step Installation
• Troubleshooting
• Support

---

Quick Install

Requirements: Root access, curl, a supported OS (Debian 11–13 or Ubuntu 22.04).

Important

Fresh Installation Required: QuickBox Pro should be installed on a fresh, minimal server installation for optimal compatibility and security. Installing on existing systems with pre-configured services is not recommended and may cause conflicts.

sudo -i
curl -sL "https://github.com/QuickBox/pro-v3/raw/refs/heads/main/qbpro_v3" > qbpro && chmod +x qbpro
./qbpro -u USERNAME -p 'PASSWORD' -k 'API_KEY'

Replace USERNAME, PASSWORD, and API_KEY with your values.

One-liner (updates system first):

sudo -i
apt-get -y update && apt-get -y upgrade && apt-get -y install curl && \
curl -sL "https://github.com/QuickBox/pro-v3/raw/refs/heads/main/qbpro_v3" > qbpro && chmod +x qbpro && \
./qbpro -u USERNAME -p 'PASSWORD' -k 'API_KEY'

---

Supported Operating Systems

Status	OS	Notes
✅ Recommended	Debian 13 (Trixie)	Best experience, current default
✅ Recommended	Debian 12 (Bookworm)	Stable, long-term choice
✅ Supported	Debian 11 (Bullseye)	Maintained, but older
✅ Supported	Ubuntu 22.04 LTS	Works out of the box, but does contain bloat
⛔ Deprecated	Debian 10 (Buster)	EOL; installs may fail

Warning

Debian 10 reached End of Life in June 2024. Upstream repos (e.g., php.sury.org) have been retired, causing fresh installs to fail. Use Debian 12 or 13.

---

Where to Get Your API Key

You need a valid API key to install QuickBox Pro.

Platform	URL	Status
v3 Platform	https://v3.quickbox.io/dashboard/api-keys	✅ Primary (launching soon!)
Classic Site	https://quickbox.io/my-account/api-keys	⚠️ Legacy (to be retired)

Important

Platform Migration: QuickBox Pro is transitioning to a new purpose-built platform at v3.quickbox.io. All new purchases and billing are handled there. If you have existing API keys or subscriptions on the classic site, use the Migration Utility at v3.quickbox.io/dashboard/migrate to transfer your keys and order history to the new platform. Your installed servers are unaffected—only your account records move. Migrate soon; the classic site will eventually be archived. Until the new site is public, you can continue purchasing and using API keys from the classic site for installations—but we recommend migrating when possible.

---

CLI Options

Required

Flag	Description
-u, --username	Admin username (alphanumeric; cannot start or end with a number)
-p, --password	Admin password (avoid special characters: !@#$%^&*()_+)
-k, --api-key	Your QuickBox Pro API key

Caution

Username Restrictions: Avoid usernames that begin or end with numbers, contain uppercase letters, or use reserved names like none, admin, root, user, or username. The none username in particular will fail with applications like rtorrent that use screen.

Password Restrictions: During initial setup, avoid special characters like !, \, /, +, @, and % as they can cause escaping issues. You can change to a stronger password with these characters after installation via the dashboard.

Optional

Flag	Description	Example
-d, --domain	Domain name for the dashboard (enables SSL)	-d mydomain.com
-e, --email	Email address for notifications/SSL	-e user@example.com
-ftp, --ftp	Custom FTP port (numeric)	-ftp 5757
-ssh, --ssh-port	Custom SSH port (numeric)	-ssh 4747
-t, --trackers	Tracker policy: allowed or blocked	-t blocked
-m, --mount	External mount path	-m /mnt/storage
-h, --help	Display help

DNS Challenge Options (for SSL via DNS validation)

Flag	Description
-dns, --dns	Enable DNS challenge for SSL
--dns-provider	DNS provider name (required with -dns in non-interactive mode)
--dns-credentials	Path to DNS credentials file (required with -dns in non-interactive mode)

Example

./qbpro -u admin -p 'MySecurePass' -k 'qbp_abc123...' -d 'server.example.com' -e 'admin@example.com' -ssh 2222 -t blocked

---

Step-by-Step Installation

1. Switch to Root

sudo -i

The installer must run as root. If sudo is not installed, log in as root directly or install it:

apt-get install -y sudo

2. Update System (Recommended)

apt-get -y update && apt-get -y upgrade

3. Install curl (if needed)

apt-get -y install curl

4. Download the Installer

curl -sL "https://github.com/QuickBox/pro-v3/raw/refs/heads/main/qbpro_v3" > qbpro && chmod +x qbpro

5. Run the Installer

./qbpro -u USERNAME -p 'PASSWORD' -k 'API_KEY'

The installer will download dependencies, validate your API key, and configure your system.

---

Troubleshooting

"API key not provided" or "Invalid API key"

• Ensure you're using the correct API key from v3.quickbox.io/dashboard/api-keys or quickbox.io/my-account/api-keys.
• Verify your license is active.

"User is not root or sudo"

The installer requires root privileges. Run:

sudo -i

"Password has invalid characters"

Passwords cannot contain: !@#$%^&*()_+

Use alphanumeric characters and basic punctuation only.

"Invalid username"

Usernames must be alphanumeric and cannot start or end with a number.

"Invalid domain name"

Domain must be a valid FQDN. Ensure DNS records point to your server before using the -d flag.

"Distro not supported"

Supported distributions: Debian 11 (Bullseye), Debian 12 (Bookworm), Debian 13 (Trixie), Ubuntu 22.04 (Jammy).

---

Support

• Website:
  • v3 Platform: https://v3.quickbox.io (preferable)
  • Classic Site: https://quickbox.io (to access legacy account features - to be deprecated)
• Documentation: https://v3.quickbox.io/docs
• Discord: https://discord.gg/mca7RSv5pa