- Home
- Knowledge Base
- Installation
- How to install QuickBox Pro – Standard Install
This is for the installation of QuickBox Pro, for information on QuickBox Community see our Github HERE. Additional comparisons between CE (Community Edition) and Pro can be found HERE.
Supported OS/Distro
Before installation
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
* 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
!
, \
, /
, +
, @
, and %
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 …
Simply fill in the USERNAME=
, PASSWORD=
, and API_KEY=
variables below, then copy and paste to get started on your install. DO NOT use any special characters in your username or password, as this will break the script from running.
USERNAME= PASSWORD= API_KEY= (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="${USERNAME}" -p="${PASSWORD}" -k="${API_KEY}";)
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
Examples
Note that these fields are unique to your wants.-u=YOURUSERNAME
, -p=YOURPASSWORD
, and -k=YOURAPIKEY
fields are required.
./qbpro -u="username" -p="password" -k="apikey"
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;)
Running lines individually:
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;