QuickBox is much more than a ‘seedbox installer script’, it is a simplistic approach to achieving easy seedbox and services management from a beautifully designed dashboard. Allowing users the ability to interact with their seedbox and server on a professional grade level.
Clone or download
JMSDOnline Merge pull request #173 from amefs/QBPR
update packages & fix bugs
Latest commit 6231530 Oct 17, 2018

README.md

QuickBox


Join the QuickBox Community!

We love our Community, in fact, we love them so much that we want to provide every possible means for our users to come together in civilized discourse for sharing ideas, techniques, tips and tricks on just about anything, and general chit chat coupled with awesome support! We don't even have to, but we do it out of love!

Check us out on the following platforms. Within you'll find friends and a supportive bunch looking to get you along. Additionally, we don't really use our GitHub for issue tracking and support, it's simply not the proper medium. I know, it's not always fun to setup yet another account, but hey, you're here right!?

Register with QuickBox.IO to get started!

The QuickBox Forums (aka The Plaza)

You got the entire Community at your back! Sort through already solved quandaries, feature requests, and current issues posted by other members.

The QuickBox IRC/Live Chat

Well, there's always someone here to address your loneliness or your issues (related to QuickBox, mmk - but not always sigh)

The QuickBox Discord Server/Live Chat

Oh yes, it's total mayhem! Fun features, live updates, games and prizes, support and a whole lot more... come find us for a late night buzz and really rediculous conversations and budding bromances.


To make use of the GitHub repo (all future updates posted here!)

This step is only required for users who are coming off of our self-hosted GitLab repositories. If you are installing from fresh, please see How to install

[1]:

login to your server via ssh. Gain root access with sudo su followed up with cd to place you in your /root directory. Once in your /root directory, type the following to remove your current local QuickBox repositories.

rm -rf ~/QuickBox

If you are already located on the GitHub repo as of v2.4.9, run the following to easily update to the new v2.5.+ QuickBox/QB repo:

rm -rf /etc/QuickBox; \
git clone https://github.com/QuickBox/QB /etc/QuickBox; \
wget -O /usr/local/bin/quickbox/system/updateQuickBox https://raw.githubusercontent.com/QuickBox/QB/master/packages/system/updateQuickBox; \
dos2unix $(find /usr/local/bin/quickbox -type f) && chmod +x $(find /usr/local/bin/quickbox -type f); \
updateQuickBox

If you have received the following error:

find: ‘/home/*/.config/deluge’: No such file or directory This simply means you do not have Deluge installed, there is no further action for you take.


NOTE:
The continuation below explains the above all-in-one code, minus the removal of the recent locations at /root/QuickBox

[2]:

grab the current/future QuickBox repository with the following:

git clone https://github.com/QuickBox/QB /etc/QuickBox

If you receive an error /etc/QuickBox already exists please perform an rm -rf /etc/QuickBox. You can then run the git clone command above to proceed.

[3]:

update your current update function by doing the following:

local_packages=/etc/QuickBox/packages/
rm -rf /usr/local/bin/quickbox
cp -r ${local_packages}/. /usr/local/bin/quickbox
dos2unix $(find /usr/local/bin/quickbox -type f)
chmod +x $(find /usr/local/bin/quickbox -type f)
cp -f /usr/local/bin/quickbox/system/reload /usr/bin/reload

[4]:

run the upgrade script to match any recent changes and to get you on your way:

updateQuickBox

Script status

Version 2.5.5-production GNU v3.0 License

Ubuntu Builds

Ubuntu 15.10 Passing Ubuntu 16.04 Passing Ubuntu 16.10 Failing

Debian Builds -- SUPPORT DISCONTINUED [USE Ubuntu 16.04]

Debian 8 Null


Quick Advisory Notice(s) on QuickBox

🚨 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 h/top.
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.


Please understand that we do not want to push this project as a means to supply a commercially used product, ie; seedbox provider - so keep this in mind - only if you wish to sale slots on your server. Though it is very multi-user friendly... it is also not free of it's faults due to it's high amount of capabilities and being publicly available. This is a community based project that is a measure of goodwill to be given to such an outspoken and freethinking community.

A Preview of Quick Box

QuickBox Preview - Smoked Theme


This script has the following features

  • A multi-user environment, complete with scripts to add and delete users.
  • Linux Quota, to control how much space every user can use in the box. This can be controlled via the 'setdisk' command.
  • Customized Seedbox Dashboard located at https://SERVER_IP/
  • HTTPs Downloads directory (https://SERVER_IP/${username}.downloads)
  • Obscures ports for ssh and ftp. SSH = 4747 | FTP = 5757 (note, this is not for security reasons... it's simply a means to reduce bad bot hits from all over the web)
  • Creates a limited shell access environment. This gives your additional created users the ability to interact with their seedbox via ssh on port 4747 w/o having access to other users shells and/or root/sudo commands and functions.

Installed software

  • IRSSI
  • Linux Quota
  • LShell - (LimitedShell for additional users to ssh)
  • mktorrent
  • pureftp - vsftp (CuteFTP multi-segmented download friendly)
  • ruTorrent 3.7 + official plugins
  • rTorrent 0.9.6 + libTorrrent 0.13.6
  • SSH Server (for SSH terminal and sFTP connections)
  • HTTPS - Web Console

Optional software

  • BTSync
  • CouchPotato
  • ConfigServer Firewall
  • Deluge (Web-client and thin-client)
  • Emby
  • Jackett
  • Lidarr
  • NextCloud
  • Medusa
  • Ombi
  • OpenVPN
  • Plex
  • Tautulli
  • pyLoad
  • qBittorrent
  • Quassel
  • Quotas
  • Radarr
  • Rapidleech
  • RTorrent (ruTorrent)
  • SABnzbd
  • SickGear
  • SickRage
  • Sonarr
  • Subsonic
  • Syncthing
  • Transmission (single-user)
  • X2Go - Remote Desktop
  • ZNC
  • .. more to come (or how about that feature request?)

Main ruTorrent plugins

autotools, cpuload, quotaspace, erasedata, extratio, extsearch, feeds, filedrop, filemanager, geoip, history, logoff, mediainfo, mediastream, ratiocolor, rss, scheduler, screenshots, theme, trafic and unpack

Additional ruTorrent plugins

  • Autodl-IRSSI (with an updated list of trackers)
  • A modified version of Diskpace to support quota (by Notos)
  • Filemanager (modified to handle rar, zip, unzip, tar and bzip)
  • Fileshare Plugin (http://forums.rutorrent.org/index.php?topic=705.0)
  • Logoff
  • Theme: QuickBox Dark rutorrent skin
  • Colorful Ratios: Customized to match QuickBox Theme
  • rutorrentMobile: Mobile version of ruTorrent - seriously - toss TransDroid and the pain that it is... this is a new essential plugin (IMO)

Before installation

You need to have a Fresh "blank" server installation. After that access your box using a SSH client, like PuTTY.


How to install

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


Ubuntu 15.10, 16.04 & 16.10 || Debian 8

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; \
git clone https://github.com/QuickBox/QB /etc/QuickBox; \
bash /etc/QuickBox/setup/quickbox-setup

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; \
git clone --branch "development" https://github.com/QuickBox/QB /etc/QuickBox; \
bash /etc/QuickBox/setup/quickbox-setup

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 upgrade

Commands

After installing you will have access to the following commands to be used directly in terminal (as root)

  • changeUserpass - change users SSH/FTP/deluge/ruTorrent password
  • clean_mem - flushes servers physical memory cache (helps avoid swap overflow)
  • createSeedboxUser - creates a shelled seedbox user
  • deleteSeedboxUser - deletes a created seedbox user and their directories This is permanent, current data will be deleted - you can create them again at any time
  • reload - restarts your seedbox services, i.e; rtorrent & irssi
  • removepackage-cron - upgrades your system to make use of systemd
  • setdisk - set your disk quota for any given user
  • showspace - shows amount of space used by each user
  • upgradeBTSync - upgrades btsync when new version is available
  • upgradeJackett - upgrades Jackett when new version is available
  • upgradeOmbi - upgrades Ombi when new version is available
  • upgradePlex - upgrades Plex when new version is available
  • upgradepyLoad - upgrades pyLoad when new version is available
  • box install letsencrypt used to install letsencrypt
  • More commands detailed here: QuickBox Commands

If your disk space widget is not showing the correct amount of space, run one of the following commands based on the mount you use:

  • If you're using a /home mounted partition then run: fix-disk_widget_home
  • If you're using a /(root) mounted partition then run: fix-disk_widget_root