README.MD
Table of Contents
Add a header to begin generating the table of contents
This is the Community Edition README
Script status
Ubuntu Builds
Quick Advisory Notice(s) on QuickBox
A Note on ARM Architecture
Nope, QuickBox is not compatible with ARM architecture. Use standard OS templates in the form of x86_x64. We additionally do not ever see QuickBox being compatible with such.
Liability Notice
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. If you would like to include QuickBox into your VPS and/or Dedicated offerings, as well as support for commercial vendors, please consider becoming a reseller.
A Preview of Quick Box
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.
Available software packages
Additional note on application packages
Please note that all software applications below are optional. The only required default application is rTorrent(ruTorrent frontend) and iRSSi(auto-downloader)
Torrent Clients
- libTorrrent 0.13.6
- rTorrent 0.9.6
- mktorrent
- ruTorrent 3.7 + official plugins
- Deluge (Web-client and thin-client)
- IRSSI AutoDL
- Transmisson
Applications
- BTSync (ResilioSync)
- ConfigServer Firewall
- CouchPotato
- Emby
- Headphones
- Jackett
- Lidarr
- Medusa
- NextCloud
- NZBGet
- NZBHydra
- OpenVPN
- Ombi
- Plex
- PlexPy
- pyLoad
- Quassel
- Radarr
- Rapidleech
- SABnzbd
- SickGear
- SickRage
- Sonarr
- Subsonic
- Syncthing
- X2Go – Remote Desktop
- ZNC
Additional Services & Features
- HTTPS – Web Console
- Linux Quota
- LShell – (LimitedShell for additional users to ssh)
- SSH Server (for SSH terminal and sFTP connections)
- VSFTP (sftp:4747 ftp:5757)
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: club-QuickBox
Dark rutorrent skin
- Colorful Ratios: Customized to match club-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
Run the following command to grab our latest stable release …
apt-get -y update && apt-get -y upgrade; apt-get -y install git lsb-release; git clone https://github.com/QuickBox/QB /etc/QuickBox; \ bash /etc/QuickBox/setup/quickbox-setup
Quick Commands
After installing you will have access to the following commands to be used directly in terminal
- 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 - changeUserpass – change users SSH/FTP/deluge/ruTorrent password
- setdisk – set your disk quota for any given user
- showspace – shows amount of space used by each user
- reload – restarts your seedbox services, i.e; rtorrent & irssi
- 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
- upgradeSABnzbd – upgrades SABnzbd when new version is available
- setup-pyLoad – type this command in ssh to run the pyLoad setup script.
- removepackage-cron – upgrades your system to make use of systemd
+ (must be on Ubuntu 15.10+ or Debian 8) - clean_mem – flushes servers physical memory cache (helps avoid swap overflow)