Before You Join Us On The Journey
Debian Flavors | |
|---|---|
Debian 11 – Bullseye is the recommended | |
Codename | Release |
Buster | 10 |
Bullseye | 11 |
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.
Important Notice About Installing
Avoid usernames that begin or end 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.
Avoid usernames such as none, admin, root, user and username 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 escaping 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.
How to Install
-
Step 1:
- Elevate your bash environment to root and move to the
/rootdirectory. -
sudo -i
- Why elevate your bash environment to root?
- Because we need to be able to write to the
/rootdirectory as well as access restricted files and operations. By usingsudo -iwe temporarily elevate our bash environment to complete more sensitive tasks; such as building and configuring nginx, php, etc…
- Because we need to be able to write to the
- If you receive a “sudo: command not found” error, please install sudo.
- sudo can be installed with the following command as root:
apt-get install -y sudo
- sudo can be installed with the following command as root:
- Why is sudo not installed?
- This is a side-effect of installation parameters from the OS build. If a root password is specified during installation of the OS, sudo is not installed by default. If a root password is not specified during installation of the OS, sudo is installed. This is more commonly seen with local installs, however, some providers may not install sudo by default.
- Why elevate your bash environment to root?
Step 2:
- It’s good practice to check your system apt.
apt-get -y update && apt-get -y upgrade
- Why check your system apt?
- Because we need to be able to install packages that are not available in the repositories. We also need to check for available general and security updates and be able to install them.
- Even though QuickBox does it for you on software installs and version updates, it’s good practice to check your system apt regularly.
- Why check your system apt?
-
Step 3:
- Grab the latest setup file.
-
curl -sL "https://lab.quickbox.io/QuickBox/pro-v3/-/raw/main/qbpro_v3" > qbpro && chmod +x qbpro
- If you receive a “curl: command not found” error, please install curl.
- curl can be installed with the following command:
sudo apt-get install -y curl
- curl can be installed with the following command:
- What is curl?
- curl is a command line tool that allows you to retrieve files from the internet.
- If you receive a “curl: command not found” error, please install curl.
-
Step 4:
- Run the installer.
-
./qbpro -u USERNAME -p 'PASSWORD' -k 'API_KEY'
USERNAME - Your username is unique to your QuickBox installation and can be whatever you like.
PASSWORD - Your password is unique to your QuickBox installation and can be whatever you like.
API_KEY - Your API Key is unique to your QuickBox account and can be found on your account.
-
Advanced Usage (Optional)
-
-d | --domain DOMAIN -e | --email EMAIL@ADDRESS -ftp | --ftp FTP_PORT -ssh | --ssh-port SSH_PORT -t | --trackers [allowed | blocked]
- example:
./qbpro -u USERNAME -p 'PASSWORD' -k 'API_KEY' -d 'DOMAIN' -e 'EMAIL@ADDRESS' -ftp FTP_PORT -ssh SSH_PORT -t blocked
- The above example will install QuickBox Pro with the following options:
- Domain: DOMAIN – the domain name of your server.
example:
-d 'mydomain.com' - This will set the Dashboard for QuickBox Pro to your domain as well as install a valid SSL certificate.
- You must have a valid domain name already registered with your provider and the proper DNS records set up.
- Email: EMAIL@ADDRESS – the email address of your user.
example:
-e '[email protected]' - It is advised to set your email if you intend on setting up a domain and SSL with Let’s Encrypt, otherwise your SSL installation could fail.
- Domain: DOMAIN – the domain name of your server.
example:
- FTP Port: FTP_PORT – the port number of your FTP server.
example:
-ftp 5757 - SSH Port: SSH_PORT – the port number of your SSH server.
example:
-ssh 4747 - Trackers: allowed – allow trackers to be downloaded.
example:
-t allowed - Trackers: blocked – block trackers from being downloaded.
example:
-t blocked
-
Run in single snippet.
- Updating username, password, and api_key details as required:
-
username="ENTER_DESIRED_USERNAME_HERE" password="ENTER_DESIRED_PASSWORD_HERE" api_key="ENTER_API_KEY_HERE" (cd /root; \ apt-get -y update && apt-get -y upgrade && apt -y install curl; \ curl -sL "https://lab.quickbox.io/QuickBox/pro-v3/-/raw/main/qbpro_v3" > qbpro && chmod +x qbpro; \ ./qbpro -u "${username}" -p "${password}" -k "${api_key}")
