Getting Started

Script status#

Version

How to install#

Hardware requirement#

  • CPU: At least a 64bit Compatible x86_64 CPU
  • RAM: large than 1GB (recommend more for better performance)
  • Storage: 20GB HDD (for seeding, you need more)

OS Support (amd64 only):

Ubuntu20.04Ubuntu18.04Ubuntu16.04

Debian10Debian9

Note

Xenial and Stretch have been removed from the master branch, please install through legacy branch. if quickbox lite was installed, it will automatically switch to the legacy branch after the upgrade.

Server Support#

  • Bare-metal server
  • Dedicated server
  • VPS with KVM/Xen/VMware (OpenVZ is not supported)
OVH DEFAULT KERNEL NOTICE!

grsec is built into OVH's custom kernel and it absolutely wrecks havoc when using these panels where we depend on the ability for one user (www-data) to see the processes of another running user ($username). This can be seen clearly by using a task manager such as htop. With grsec enabled you can only see the processes owned by your user unless you run htop as root. As such, it is highly recommended to use the stock kernel for your distribution or at the very least installing an OVH kernel that is not compiled with grsec If you are using So You Start (SYS) as a host, you should opt to use the distribution kernel. You will see this as a check box option when installing your server. Otherwise, QuickBox will handle this for you on install.

One-key Install mode#

You must be logged in as root to run this installation.

One-key install is available since version 1.3.3:

bash <(curl -sLo- https://git.io/qbox-lite) COMMAND

Want to run in development mode?:

bash <(curl -sLo- https://git.io/qbox-lite) --dev COMMAND

Now, it has following arguments:

QuickBox Lite Setup Script
Usage: bash setup.sh -u username -p password [OPTS]
Options:
NOTE: * is required anyway
-d, --domain <domain> setup domain for server
-H, --hostname <hostname> setup hostname, make no change by default
-P, --port <1-65535> setup ssh service port, use 4747 by default
-u, --username <username*> username is required here
-p, --password <password*> your password is required here
-r, --reboot reboot after installation finished (default no)
-s, --source <us|au|cn|fr|de|jp|ru|uk|tuna>
choose apt source (default unchange)
-t, --theme <defaulted|smoked> choose a theme for your dashboard (default smoked)
--tz,--timezone <timezone> setup a timezone for server (e.g. GMT-8 or Europe/Berlin)
--lang <en|zh> choose a TUI language (default english)
--with-log,no-log install with log to file or not (default yes)
--with-ftp,--no-ftp install ftp or not (default yes)
--ftp-ip <ip address> manually setup ftp ip
--with-bbr,--no-bbr install bbr or not (default no)
--with-cf use cloudflare instead of github
--with-sf use sourceforge instead of github
--with-osdn use osdn(jp) instead of github
--with-github use github
--with-APPNAME install an application
--qbittorrent-version specify the qBittorrent version
--deluge-version specify the Deluge version
--qbit-libt-version specify the Libtorrent version for qBittorrent
--de-libt-version specify the Libtorrent version for Deluge
--rtorrent-version specify the rTorrent version
Available applications:
rtorrent | rutorrent | flood | transmission | qbittorrent
deluge | mktorrent | ffmpeg | filebrowser | linuxrar
-h, --help display this help and exit

The username and the password is required anyway, or the TUI install method will start. The other arguments are the same function as in TUI. Here is a example:

bash <(wget -qO- https://git.io/qbox-lite -o /dev/null) -u demouser -p demo123456 --with-ffmpeg -P 1234 --with-bbr --with-deluge --with-mktorrent --with-linuxrar --with-cf --hostname vmserver --reboot

It means: The username being set to demouser, password is demo123456, use 1234 as ssh port, install BBR, deluge, mktorrent, linuxrar. The mirror for deb package in Cloudflare will be used for installation. Change the hostname to vmserver. The server will be automaticly restart after installation.

TUI install#

Run the following command to grab our latest stable release ...

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

Want to run in development mode?

Run the following command to grab current development repos ...

mkdir /install/ && touch /install/.developer.lock; \
apt-get -yqq update; apt-get -yqq upgrade; apt-get -yqq install git lsb-release dos2unix; \
git clone --branch "development" https://github.com/amefs/quickbox-lite.git /etc/QuickBox; \
dos2unix /etc/QuickBox/setup.sh; \
bash /etc/QuickBox/setup.sh

Already have QuickBox installed and want to switch over to development?#

EASY! Run the following command to grab current development repos ...

mkdir /install/ && touch /install/.developer.lock; \
sudo box update quickbox

In v1.4.6 and above, you can swith to development mode with box enable-dev.


Installed Features#

  • pureftp - vsftp (CuteFTP multi-segmented download friendly)
  • SSH Server (for SSH terminal and sFTP connections)
  • Web Console (Shellinabox)
  • QuickBox Dashboard

Available software#

Available when setup#

  • rTorrent
    • ruTorrent
    • flood
  • Transmission
  • qBittorrent
  • Deluge
  • mktorrent
  • FFmpeg
  • Linux RAR
  • File Browser
  • BBR

Available in dashboard#

  • Autodl-irssi
  • BTSync
  • CIFS
  • FlexGet (both 2.x and 3.x)
  • Netdata
  • NFS
  • noVNC
  • OpenVPN
  • Plex
  • Syncthing
  • Speedtest
  • x2Go

Available in CLI#

  • autoremove-torrents
  • Denyhosts
  • Fail2ban
  • Let's Encrypt
  • ZNC

Have trouble with QuickBox Lite#

If you still have questions about the QuickBox Lite or need to report bugs, be sure to read the Wiki first. When you still have trouble with it, please assign an issue here, I will try my best to help you.