Supported Operating Systems
Heads up on Distro selection for install
With QuickBox Pro v3 right around the corner (aiming for a New Years release!), it is advised to install QuickBox Pro v2 (the current iteration) on Debian 10. This is the preferred OS of QuickBox as it contains less bloat and offers more performance in regards to the type of Utility and the software that QuickBox is/includes. v3 will only support Debian 9, 10, and 11 (once it's fully supported)
Installing v2 on Ubuntu will result in needing a fresh install should you decide to upgrade to v3. Debian 9 and 10 will be upgraded from v2 to v3, problem free with zero need for a reinstall.
Ubuntu Flavors v2
Debian Flavors v2, v3
You need to have a Fresh “blank” server installation. After that access your box using a SSH client, like PuTTY. Please run in root to avoid conflicts. Additionally, ensure that you have your QuickBox Pro API Key available, you can learn more about how to attain that in this article.
If you login to your server as sudo user, please run
sudo su - to properly elevate your permissions to root. This is necessary to avoid potential permissions issues when building the database for QuickBox Pro.
Also advisable to run below code to make certain your server has gotten a full update before stating the installation!
apt-get -y update && apt-get -y upgrade && apt-get -y autoclean apt-get -y install sudo dirmngr curl wget git net-tools iproute2
How to install
IMPORTANT NOTICE ABOUT INSTALLING
DO NOT use a username that begins or ends with a numeric character or contains uppercase letters. This can cause issues with permissions as well as odd quirks within Linux that are undesirable. This is not a QuickBox limitation, rather this is a limitation with Linux and/or various applications. We have to make them happy in various ways, so best practice is to keep things simple.
DO NOT use usernames such as none, admin, root as these are system reserved and could cause breakage on certain functionality in QuickBox Pro. none in particular will fail with applications such as rtorrent that utilize screen as none is a pre-set variable.
Additionally, try to avoid using characters such as
% in usernames & passwords on setup as this can cause an identifying issue within Linux. Please note however, that after installation is finished, you can edit your password to be much stronger as the dashboard password edit allows these additional characters.
Run the following command to grab our latest release …
cd /root && wget -q https://lab.quickbox.io/QuickBox/Pro/raw/master/qbpro && chmod +x qbpro
Finally, run the following to begin your QuickBox Pro installation …
./qbpro -u=YourUsername -p='YourPassword' -k=1234567890123456789;
What do these values mean?
##### Options: -u, --username The QuickBox primary user -p, --password The QuickBox primary user password -k, --api_key The API Key associated with your install -ssh, --ssh_port The optional ssh port you would like to assign to your server -ftp, --ftp_port The optional ftp port you would like to assign to your server -m, --mount Custom mount point for HDD status on dashboard --reboot Automatically reboot at end of setup -h, --help Display this help and exit -v, --version Output version information and exit
Running the entire block and adding your username, password, and API key to the block code:
(apt-get -y update && apt-get -y upgrade && apt-get -y autoclean; apt-get -y install sudo dirmngr curl wget git net-tools iproute2; cd /root && wget -q https://lab.quickbox.io/QuickBox/Pro/raw/master/qbpro && chmod +x qbpro; ./qbpro -u=YourUsername -p='YourPassword' -k=1234567890123456789;)