Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/QuickBox/QB
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.
https://github.com/QuickBox/QB
debian media-server quickbox seedbox seedbox-install-script ubuntu
Last synced: about 1 month ago
JSON representation
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.
- Host: GitHub
- URL: https://github.com/QuickBox/QB
- Owner: QuickBox
- License: gpl-3.0
- Created: 2017-04-06T19:17:13.000Z (over 7 years ago)
- Default Branch: master
- Last Pushed: 2022-03-31T17:14:33.000Z (over 2 years ago)
- Last Synced: 2024-10-30T08:17:41.281Z (about 1 month ago)
- Topics: debian, media-server, quickbox, seedbox, seedbox-install-script, ubuntu
- Language: JavaScript
- Homepage: https://quickbox.io
- Size: 14.8 MB
- Stars: 736
- Watchers: 34
- Forks: 169
- Open Issues: 36
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-hacking-lists - QuickBox/QB - 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 (JavaScript)
README
[](https://quickbox.io)
---
## Deprecation Notice
>Please be advised that we are sunsetting developments and any support on this Community Edition of QuickBox as we are devoted to the further developments of [QuickBox Pro](https://quickbox.io/product/quickbox-pro-subscription/). There is a lot of work daily that goes into QuickBox and I simply do not have enough time to manage the Free edition as well as the Pro edition, you can still roll with this CE, jsut keep in mind that some software may not install properly or dependencies may become deprecated. We welcome any Pull Requests from users and you are more than welcome to post patches for our review and inclusion to keep this edition going!
## 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!?
### 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.
* ##### [QuickBox on Discord](https://discord.gg/hCCbVhu)
---
## Security Notice
As of `v2.6.0` of QuickBox Community Edition (Pro Edition v2.4.8 - run a `qb fix version`) we have patched several security vulnerabilities that were brought to our attention. Huge thanks goes out to Joel from [WebSEC.nl](https://websec.nl/) for the responsible disclousure and working with me to get these items addressed.
To update your QuickBox Community Edition to the latest upstream fixes (as of `v2.6.0`), run in CLI `box upgrade`.
---
## Script status
[](https://quickbox.io/readme-md/) [](https://quickbox.io/readme-md/)
#### Ubuntu Builds
[](https://quickbox.io/readme-md/) [](https://quickbox.io/readme-md/)
#### Debian Builds
[](https://quickbox.io/readme-md/)
---
### Quick Advisory Notice(s) on QuickBox
>### :rotating_light: 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
---
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
## 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 16.04 & 18.04 || Debian 9
**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 bc; \
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](https://quickbox.io/wiki/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__