Skip to content

FAQ

Jump to bottom
EFS edited this page Sep 16, 2020 · 22 revisions

Table of Contents

How to create a public download directory?

You can use nginx fancyindex to create a read-only download link:

sudo su -
cd /etc/nginx/apps
touch $username.public.conf
cat > $username.public.conf << EOF
location /$username.public {
  alias /home/$username/public;
  include /etc/nginx/snippets/fancyindex.conf;
  location ~* \.php$ {

  }
}
EOF
nginx -s reload

please change the $username as well as alias /home/$username/public . You will be able to access your folder via https://YOURDOMAIN/$username.public

How to enable the share link of File Browser?

To enable share link function, you need to disable Nginx authorization and enable the File Browser authorization service. Here is the manual.

  • Stop File Browser service

    sudo su -
systemctl stop filebrowser@$username

  • reconfigure filebrowser

    filebrowser -d /home/$username/.config/filebrowser/filebrowser.db config set --address 0.0.0.0 --auth.method=json

  • disable nginx basic auth, commit following line in /etc/nginx/apps/filebrowser.conf

    #auth_basic "Password Required";
#auth_basic_user_file /etc/htpasswd.d/htpasswd.$remote_user;

  • give your username to Nginx reverse proxy:

    proxy_pass http://$username.filebrowser;

  • restart service

    nginx -s reload
systemctl start filebrowser@$username
How to connect Flood to rTorrent?

When you initialize Flood, choose Unix, and fill with the following info, $username needs to be replaced.

/var/run/$username/.rtorrent.sock
Why the auth popup windows keeping asking your auth info after login Flood?

The Flood also use Basic auth, so the Cookies will be changed after successfully authenticated. For now, there is currently no fundamental solution.

Why my torrents being rechecked after restart the BT client?

BT clients record resume data periodically. When these data didn't save into its database when closing the client, it will cause the recheck action to ensure data integrity. When you need to shut down the client (as well as halt your server), please pause all the active torrents and wait about 5 min.

How to connect my application WebUI with IP:Port?

The most applications in QuickBox Lite are using Nginx reverse proxy to protect them. If you want to access your application directly, you have to modify the application configuration. e.g. In qBittorrent, you need to find Web User Interface (Remote control) > IP address, change default 127.0.0.1 to 0.0.0.0. The software will be able to connect directly after saving your config.

Why it fails to add a bunch of torrents to BT Client via WebUI?

QuickBox Lite has a limit in reverse proxy. The upload file size is limited to 32MB per session. It may crash or failed when the limit is exceeded. You can modify Nginx configure to resolve: enlarge client_max_body_size in /etc/nginx/snippets/proxy.conf and restart Nginx.

Where is the flexget execute file?

The FlexGet is installed under user privilege. So the execution located in /home/${username}/.local/bin. Recommend to run crontab under user privilege. e.g.

# min hour  day month week  user         command
  *   *     *   *     *     ${username}  /home/${username}/.local/bin/flexget COMMAND

From version 1.3.5, the FlexGet will provide with pyenv. The execution located in /home/${username}/.local/flexget3/bin/flexget. Here is an example for cronjob

crontab -e -u ${username}
add following things(execute every minute):
# min hour  day month week    command
  */1 *     *   *     *       /home/${username}/.local/flexget3/bin/flexget -c /home/${username}/.config/flexget/config.yml --cron execute

Visit Official document for more information.

How to use autoremove-torrents?

After installing autoremove-torrents, you will find config.yml under /home/${username}/.config/autoremovetorrents, it includes some basic use case. Visit Official document for more information. You can execute with following command:

/home/${username}/.local/autoremovetorrents/bin/autoremove-torrents -c /home/${username}/.config/autoremovetorrents/config.yml -l /home/${username}/.config/autoremovetorrents/logs

cronjob example:

crontab -e -u ${username}
add following things(run once every hour):
# min hour  day month week    command
  0   *     *   *     *       /home/${username}/.local/autoremovetorrents/bin/autoremove-torrents -c /home/${username}/.config/autoremovetorrents/config.yml -l /home/${username}/.config/autoremovetorrents/logs
How to add a Cloudflare CDN?

You need to buy a domain and create a Cloudflare account, add the domain to the Cloudflare dashboard. Make sure there is an A Record for your server. The Proxy status should be Proxied. You may find it redirect loop after enabling Cloudflare, which caused by the Nginx config problem. You have 2 Solutions:

  • Fix it with the following code:
domain=YOUR DOMAIN
cat > /etc/nginx/sites-enabled/default <<NGC
server {
    listen 80 default_server;
    listen [::]:80 default_server;
    server_name ${domain};

    location /.well-known {
      alias /srv/.well-known;
      allow all;
      default_type "text/plain";
      autoindex    on;
    }

    client_max_body_size 40M;
    server_tokens off;
    root /srv/;

    index index.html index.php index.htm;

    location ~ \.php$ {
        include snippets/fastcgi-php.conf;
        fastcgi_pass unix:/run/php/$sock.sock;
        fastcgi_param SCRIPT_FILENAME \$document_root\$fastcgi_script_name;
    }

    include /etc/nginx/apps/*;

    location ~ /\.ht {
        deny all;
    }

    location /fancyindex {

    }
}

# SSL configuration
server {
    listen 443 ssl http2 default_server;
    listen [::]:443 ssl http2 default_server;
    server_name ${domain};
    ssl_certificate /etc/ssl/certs/ssl-cert-snakeoil.pem;
    ssl_certificate_key /etc/ssl/private/ssl-cert-snakeoil.key;
    include snippets/ssl-params.conf;
    client_max_body_size 40M;
    server_tokens off;
    root /srv/;

    index index.html index.php index.htm;

    location ~ \.php$ {
        include snippets/fastcgi-php.conf;
        fastcgi_pass unix:/run/php/$sock.sock;
        fastcgi_param SCRIPT_FILENAME \$document_root\$fastcgi_script_name;
    }

    include /etc/nginx/apps/*;

    location ~ /\.ht {
        deny all;
    }

    location /fancyindex {

    }
}
NGC
nginx -s reload

After clearing the browser cache, the problem can be solved in most cases. For security, you can open SSL/TLS -> Always Use HTTPS in the Cloudflare Control Panel.

  • Change Settings on Cloudflare:

This problem appears at SSL/TLS encryption mode is Flexible, the Cloudflare will visit your server via Port 80, which will receive a redirect signal to 443 by nginx. So just change the SSL/TLS encryption mode to Full to use the 443 by default will solve it.

Where is the installation log?

QuickBox Lite save your application installation log under /srv/dashboard/db/output.log. You can run tail -f /srv/dashboard/db/output.log to get real-time output in a new SSH session.

How to install QuickBox with a proxy?

Sometimes you will get installation failed caused by network problem (e.g. unstable CDN of software). You can solve it by applying a proxy. Here's a method(proxychains-ng):

  • compile and install the latest proxychains-ng(needs root privilege):

    cd /tmp
git clone https://github.com/rofl0r/proxychains-ng
cd proxychains-ng
./configure --prefix=/usr --sysconfdir=/etc
make 
make install
make install-config

  • configure the proxychains-ng:

    vim /etc/proxychains.conf

quiet_mode
proxy_dns
[ProxyList]
socks5  127.0.0.1 6666
http    127.0.0.1 6666

  • apply proxychains-ng while installing:

    proxychains4 -q bash /etc/QuickBox/setup.sh # for QuickBox installation
proxychains4 -q box install novnc # for software installation
How to upgrade / downgrade a application?

The easiest way is to run box update APP. File Browser, Flexget, Netdata, qBittorrent, rTorrent, ruTorrent are currently supported for upgrading, and rTorrent, Deluge, qBittorrent are supported for specific versions. qBittorrent and rTorrent can be downgraded.

rTorrent downgrade 0.9.8 -> 0.9.4

box update rtorrent -v 0.9.4

qBittorrent downgrade 4.2.1 -> 4.1.8 (--force flag is required)

box update qbittorrent --qb 4.1.8 --force
How to connect OpenVPN?

You need to install an OpenVPN Client first. The configuration file can be found in ovpn.zip from OpenVPN Config on QuickBox Dashboard. After uncompressed the file, you can get the configuration file. It can be used to start a connection. You will get an IP address in range 10.8.0.0/24

How to create a new OpenVPN user?

you have to manage the user with this script:

cd /tmp
curl -O https://raw.githubusercontent.com/angristan/openvpn-install/master/openvpn-install.sh
chmod +x openvpn-install.sh
./openvpn-install.sh

You can manage users with the guide in the script.

How to connect NFS/CIFS?
  • CIFS has already enabled encryption and basic authorization by default. The account is the same as the dashboard. E.g., You can connect to the server in Windows by typing \\[your server IP address] on the address bar in explorer.
  • NFS doesn't have a authorization function or encrypt transfer method. So I recommend to use it in LAN, or use it via OpenVPN. You can install OpenVPN and create a security connection first. When you use OpenVPN, the destination IP address is: 10.8.0.1
Clone this wiki locally