Community Edition

How should I partition my server

The QuickBox Recommendation

We recommend using RAID0 and using mount point /(root). Removing the /home  mount point if possible from your server allows more room for all your apps such as plex if it grows fast as some will. Additional to the QuickBox dashboard will only recognize and support /(root) and /home .

Current notables

QuickBox Community Edition does not support custom and/or additional mounts such as /data , /media etc. See QuickBox Pro if this is a feature that is a must for you.

Back To Top

How to install QBCE

You can install QuickBox Community Edition (QBCE) using our given method. Please be advised that the install script must be ran by the root user and within the /root directory.

 

apt-get -yqq update; apt-get -yqq upgrade; apt-get -yqq install git lsb-release; \
git clone https://github.com/QuickBox/QB /etc/QuickBox; \
bash /etc/QuickBox/setup/quickbox-setup

Back To Top

Install Let’s Encrypt

Using Let’s Encrypt for SSL on your seedbox is a great way to have a valid certificate and avoid all the nag screens and exceptions that you have to jump through when dealing with self-signed certificates. Let’s Encrypt provides an easy way to obtain and install trusted certificates for absolutely no cost, other a couple of minutes of time.

Before we start, it is required that you have a valid domain name. Purchase one anywhere you like… they are not too expensive. You will then need to setup an A Record for the domain to point the IP of your seedbox towards. I would recommend CloudFlare… there are several reasons why CloudFlare is a good choice, but the biggest is that once again, it’s free.

Setup and install Let’s Encrypt

Option 1: Sever has its own Domain

apt-get -y install git
git clone https://github.com/letsencrypt/letsencrypt /opt/letsencrypt
cd /opt/letsencrypt
./letsencrypt-auto --apache -d your_domain.com -d sub.your_domain.com

Replace your_domain.com and sub.your_domain.com with that of your actual domain. Subdomains are only needed if you are attaching your seedbox to another domain, ie; mybox.domain.com use Option 2.

Option 2: Server is on a Subdomain

apt-get -y install git
git clone https://github.com/letsencrypt/letsencrypt /opt/letsencrypt
cd /opt/letsencrypt
./letsencrypt-auto --apache -d sub.your_domain.com

 ? Heads Up!

You may receive a prompt asking which configuration file to use for Let’s Encrypt, it is important that you choose 000-default.conf and not default-ssl.conf. Choosing default-ssl.conf can and in most cases wipe the QiuckBox default-ssl.conf already in place, this results in needing to rebuild the apache configuration files.

Then setup auto-renewal of the ca-certificate

./letsencrypt-auto renew

Now add a crontab

sudo crontab -e

Enter the following:

30 2 * * 1 /opt/letsencrypt/letsencrypt-auto renew >> /var/log/le-renew.log

Save and exit.

This will create a new cron job that will execute the letsencrypt-auto renew command every Monday at 2:30 am. The output produced by the command will be piped to a log file located at /var/log/le-renewal.log.

Next, you will also need to change your DocumentRoot after you install let’sencrypt … The good news is you can do it with one string :

sed -i "s|DocumentRoot /var/www/html|DocumentRoot /srv/rutorrent/home/|g" /etc/apache2/sites-enabled/000-default-le-ssl.conf && service apache2 restart

 

Back To Top

Pro Edition

Standard Server Install

Supported OS/Distro

Ubuntu 16.04 Passing Ubuntu 18.04 Passing Debian 9 Passing

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.

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.

How to install

IMPORTANT: DO NOT use usernames such as admin or root as these are system reserved and could cause breakage on certain functionality in QuickBox Pro. Additionally, try to avoid using characters such as !, \, /, +, @, and % in 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 …

wget -q https://lab.quickbox.io/QuickBox/Pro/raw/master/qbpro && chmod +x qbpro; \
./qbpro -u='username' -p='password'

What do these values mean?

Options:
-u, --username The QuickBox primary user
-p, --password The QuickBox primary user password
-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' and -p='YOURPASSWORD' fields are required.
./qbpro -u='username' -p='password'

Video Demo

Check out how this works in the below video demonstration.

Back To Top

Docker Install

Supported OS/Distro

Ubuntu 14.04 Passing Ubuntu 16.04 Passing Ubuntu 18.04 Passing Debian 8 Passing Debian 9 Passing

How to install

IMPORTANT: DO NOT use usernames such as admin or root as these are system reserved and could cause breakage on certain functionality in QuickBox Pro. Additionally, try to avoid using characters such as !, \, /, +, @, and % in passwords on setup as this can cause an identifying issue within Linux.

Install git

apt-get -y install git lsb-release

Grab the QuickBox Pro Docker Repo

git clone https://lab.quickbox.io/QuickBox/Pro-Docker.git quickbox; \
cd quickbox; \
cp -u /root/quickbox/qb -t /usr/bin && chmod +x /usr/bin/qb

Build your QuickBox Container

qb build quickbox USERNAME PASSWORD MOUNT

Note: Enter the MOUNT as /home, /root, or otherwise. Always starting with a forward slash

Running QuickBox Container Control

To ENTER your quickbox container
qb enter quickbox
To START your quickbox container
qb start quickbox
To STOP your quickbox container
qb stop quickbox
To RESTART your quickbox container
qb restart quickbox
To SHOW STATS for your quickbox container
qb stat quickbox
To SHOW LOGS for your quickbox container
qb log quickbox
To REBUILD your quickbox container
qb rebuild quickbox USERNAME PASSWORD MOUNT

Note: Enter the MOUNT as /home, /root, or otherwise. Always starting with a forward slash

To DESTROY your quickbox container

IMPORTANT!
Destroying your container will remove all volumes on the host machine as well

qb destroy quickbox
To CLEANUP old containers

Remove all containers the have stopped for > 24 hours
– Delete all docker images for old containers
– Delete all stopped and orphan containers

qb cleanup
To UPDATE your qb controller
qb update

Back To Top

GUI Install

The final step of QuickBox Pro setup is the GUI Installer. This is essential in verifying your permissions, gathering additional details, as well as finalizing the database build for your QuickBox Pro Dashboard.

At the end of your setup script, you will have seen a notice to complete the installation, you must visit https://SERVERIP/install.

 

Upon visiting the GUI install link after a server reboot, you will see the following screen.

Please note, visiting just the IP will result in the following message:

Click here to proceed to the installer or else remove the install directory after installation and then refresh the page to continue.

 

The GUI Setup consist of the following tabs:

  1. Requirements – This is to verify your php version (Currently php7.2-fpm), as well as if the PDO module is enabled and your config file is writable. The latter being essential to reading and connecting your database and dashboard.
  2. Paths – Here you can insert your disk mount as well as modify your install path. Be advised that the additional fields should stay as they are. Any modification to these fields could result in unwanted side-effects.
    • Disk Mount :: This will be the main mount point for reading your disk data. If you happen to not know your primary partition, you can type lsblk to see your drive mounts. More than likely, your primary mount point will be the partition listed with the most available space
    • Install Path :: On the initial IP access, this will have your IP placed here. If you have a top level domain, or have order the DNS Service from QuickBox for a subdomain, you can go ahead and enter it within this field. It is important that when entering the domain, you keep the trailing forward slash (eg: good https://domain.com/ bad https://domain.com)
  3. Database – Fields on this page should be left as is. These details are here only as a means to verification.
  4. Admin – The only field required on this page is your Admin E-mail Address. Additional fields are for verification only and are generated from the initial setup script.
  5. Summary – The Summary tab is a complete summary of your install details. Verify that your information is correct and click Finish to build your database and complete your QuickBox Pro installation.

 

Video Demo

Check out how this works in the below video demonstration.

Back To Top

Activating your QuickBox Pro License

After you finish the install and login, an important order of business is getting your License activated. Activating your license will unlock various features on your Dashboard, as well as enable many QuickBox system commands. Be sure to have your license and your email associated with the license handy. You can find your license located in your completed order email sent to you after successful purchase.

You will now need to navigate to the General Settings Page on your dashboard.

Once you are on the General Settings Page, you will notice the License Control module.

Enter in the License Key and the E-mail associated with your License Key from purchase.

Once both fields have been completed, select Yes for Activate License, then hit the Submit Changes button to activate.

Activation is instant if the proper info is entered.

Back To Top

How to change your password

Changing your password is a very simple process. You will notice that the Super Administrator is not listed within the User Admin page, this is to ensure additional securities with the System Admin account. To change the Super Admin password, simply click on the username dropdown in the top right of your dashboard and select Profile.

Once you are within your your Profile, select the Edit Account tab.

From the Edit Account tab, you will now see the options to change your password. Enter your new password, then additional confirm password and hit Submit Changes.

Back To Top

How to set your domain

If you have a top level domain, or have purchased a subdomain via the DNS Service provided by QuickBox, you may want to use that for your dashboard rather than the server IP. This has a couple of advantages.

  • Easier to remember URL for your QuickBox Dashboard
  • Ability to setup a certificate via the Let’s Encrypt installer

Add your Domain

To add your domain, navigate to the General Settings Page.

Now scroll down to the field labeled Site Root * within the Configuration Settings panel. You will see that by default, your server IP address is listed in this field.

Simply change this to your domain name that you would like to use with QuickBox.

Please take note:
The domain entered must end with a trailing forward slash /. Failure to add the trailing forward slash can result in redirect loops which will cause bad links and your dashboard to be inaccessible. (eg: https://mydomain.comlogin.php <- Notice there is no forward slash between the domain name and the additional pages)

If you do manage to add the domain without the forward slash, simply navigate back to your dashboard via the IP address https://SERVERIP/configurations.php and you will be able to set the Site Root accordingly.

Save your changes!

Once you have added your domain name to the Site Root, Hit the Submit Changes button and logout to initiate the change, as well as flush the sessions cookies so they will now honor your domain.

 

Access your Dashboard from your new domain

Upon logging out, you will probably still be located on your server IP, trying to login here will redirect you back to your new domain. Once you see your domain in your address bar, simply login and you’re ready to move on!

Back To Top

How to install Let’s Encrypt

If you have a top level domain, or have purchased a subdomain via the DNS Service provided by QuickBox, you may want to install an SSL certificate. This has a couple of advantages.

  • Rid yourself of the nag screens browsers produce from self-signed ssl certificates
  • Secure connections via authenticated SSL certificates

Before continuing, please ensure that you have followed the steps for adding your domain.

In most cases, upon successful install of QuickBox, you will encounter a screen informing you that the page you are visiting is not secure and has an invalid SSL certificate. This is due to the self-signed certificates that are installed by default on the installation of QuickBox. Self-signed certificates still have the benefit of encrypting your connections over https. This does not mean your connection is not safe. Due to the nature of self-signed certificates, modern browsers will produce this message since the certificate has not been signed by a verified authority that the browser understands. One way around this is installing a certificate with Let’s Encrypt.

Install your ssl certificate

Login to your dashboard and navigate to the Apps Dashboard

Once on your Apps Dashboard select the Application Management tab. The Application Management tab is where you will find all available applications for install/uninstall.

Next, either search or scroll down to the Lets Encrypt entry and select Install.

You will now be greeted with a popup where you will insert your top level domain name. Only enter the domain without https:// or / (eg: good domain.com good sub.domain.com good sub-plex.domain.com bad https://domain.com bad domain.com/ … etc.)

Once you have entered in your domain, hit the button for Submit Changes.

The certificate installation process will now commence in the background. Upon completion, your browser will refresh, please wait until the refresh as interrupting the process could result in a failed certificate generation.

On browser refresh it is sometimes needed to do a hard refresh on your browser. You can do this by hitting ctrl + shift + R on your keyboard. After a refresh, your connection should now show as secured. You can verify the certificate by clicking on the lock icon and viewing more info on the connection.

 

Video Demo

Check out how this works in the below video demonstration.

 

Back To Top

How to install Quotas

About the Quota installer

Users can now directly edit their fstab to ensure a proper mount for quotas, this is especially great for those with mount points such as /mnt /media /somethingweird. So in short, QuickBox Pro now lifts the limitations seen in QuickBox Community when it comes to handling custom mount points.

Setting your primary mount point for Quotas

If you have installed QuickBox Pro using the setup binary as of v0.5.6, then you have entered your mount partition on the GUI setup. If this is the case, you can skip the next segment and move on to Example of editing your fstab from the Quota installer.

Finding your Primary Partition for mounting quotas

To find your primary partition is a simple task, from shell as sudo or root, run the command df. This will have an output such as the following:

# df
Filesystem     Type      Size  Used Avail Use% Mounted on
udev           devtmpfs  7.8G     0  7.8G   0% /dev
tmpfs          tmpfs     1.6G  156M  1.4G  10% /run
/dev/md2       ext4      205G   79G  117G  41% /
tmpfs          tmpfs     7.8G  8.0K  7.8G   1% /dev/shm
tmpfs          tmpfs     5.0M     0  5.0M   0% /run/lock
tmpfs          tmpfs     7.8G     0  7.8G   0% /sys/fs/cgroup
/dev/md0       ext4      464M  109M  327M  26% /boot
overlay        overlay   205G   79G  117G  41%

What you are looking for is typically the drive with the most space available. In this case, it’s the /(root) mount.

Entering your Primary Partition for mounting quotas

Now that you know your primary partition, navigate to the General Settings page and locate the field titled Disk Mount. Within this field you will enter the partition for quotas to make use of. For purposes of our demo, we will enter / for the root mount.

Next, click the Submit Changes button and proceed to install quotas from your dashboard’s Application Management Center on the Apps Dashboard.

Example of editing your fstab from the Quota installer

When installing quotas, you’ll notice there is a field entered with the specific string that needs to be added…

usrjquota=aquota.user,jqfmt=vfsv1,errors=remount-ro

…thus, if you’re using Hetzner, you may see somethin like the following:

proc /proc proc defaults 0 0
/dev/md/0 none swap sw 0 0
/dev/md/1 /boot ext3 defaults 0 0
/dev/md/2 / ext4 defaults 0 0
/dev/md/3 /home ext4 defaults 0 0

In this for instance, your primary mount point is on /root. Therefore, as per the suggested string that is posted for change, you’re updated fstab field will look like the following edit:

proc /proc proc defaults 0 0
/dev/md/0 none swap sw 0 0
/dev/md/1 /boot ext3 defaults 0 0
/dev/md/2 / ext4 usrjquota=aquota.user,jqfmt=vfsv1,errors=remount-ro 0 1
/dev/md/3 /home ext4 defaults 0 0

Video Demo

Check out how this works in the below video demonstration.

 

Back To Top