Giter Site home page Giter Site logo

looxxp / quickbox-lite Goto Github PK

View Code? Open in Web Editor NEW

This project forked from amefs/quickbox-lite

0.0 1.0 0.0 4.01 MB

Lightweigt QuickBox

License: GNU General Public License v3.0

Shell 40.28% Python 1.04% Hack 0.01% PHP 8.11% JavaScript 10.09% CSS 40.17% TypeScript 0.30%

quickbox-lite's Introduction

QB-lite

Project QuickBox-Lite

中文版


This project is a modified version of the QuickBox community edition. This project aims to build a lightweight QuickBox software kit. Most of the functions of QuickBox CE are retained, but only the most commonly used stable third party software included. The prebuilt BT client also available here, which can significantly reduce the installation time as well as CPU requirement to compile them. Most of the software is available as modules. The panel no longer needs the support of ruTorrent. You can select what you need, and this is also why the project named "Lite".

For more information, please check our wiki.


Main feature

  1. Graphical installation guide (Multi-language available)
  2. Use Nginx instead of apache
  3. Modular installation
  4. Latest OS support
  5. up to date apps (prebuild deb packages included)

Script status

VersionGNU v3.0 License

When upgrade from 1.3.2 to 1.3.3, very recommend to use SSH with box update quickbox. You also need to run the command twice to finish the service upgrade. If you are using WebUI to finish the upgrade, please also upgrade twice.

From version 1.3.6, the php version has upgraded to 7.4, so you can remove old php7.2 with sudo apt purge php7.2* when you don't need it anymore.


How to install

before 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.04Debian9Debian10

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.

install the project

You must be logged in as root to run this 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

One-key Install mode

One-key install is available since version 1.3.3:

bash <(wget -qO- https://git.io/qbox-lite -o /dev/null) COMMAND

Want to run in development mode?:

bash <(wget -qO- https://git.io/qbox-lite -o /dev/null) --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

  -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)
  --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 sourceforge
  --with-sf                        use sourceforge
  --with-osdn                      use osdn(jp) instead of sourceforge
  --with-APPNAME                   install an application

    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.

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

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 (0.9.4-0.9.8)
    • ruTorrent
    • flood
  • Transmission (2.94)
  • qBittorrent (4.2.5)
  • Deluge (1.3.15, 2.0.3)
  • mktorrent (with createtorrent command as wrapper)
  • FFmpeg
  • Linux RAR
  • File Browser
  • BBR

Available in dashboard

  • Autodl-irssi
  • BTSync
  • FlexGet (both 2.x and 3.x)
  • Netdata
  • noVNC
  • Plex
  • Syncthing
  • 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.

quickbox-lite's People

Contributors

amefs avatar tautcony avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.