QBittorrent VPN

---

Table of Contents

1. Intro
2. Summary
3. Access Information
4. Configuration

---

1. Intro

qBittorrent is a bittorrent client programmed in C++ / Qt that uses libtorrent (sometimes called libtorrent-rasterbar) by Arvid Norberg. It aims to be a good alternative to all other bittorrent clients out there. qBittorrent is fast, stable and provides unicode support as well as many features. This Docker image is using the headless configuration with the web frontend enabled, as well as OpenVPN to ensure a secure and private connection to the Internet, including use of iptables to prevent IP leakage when the tunnel is down. Privoxy is also included to allow unfiltered access to index sites, to use Privoxy please point your application at qbittorrent:8118. (credit: binhex)

For the non-vpn version of this app, just leave "VPN enabled" set to "NO". If you do use the VPN Option, please add the following IP when connecting Sonarr/Radarr "172.18.0.55". If you do NOT use the VPN Option, use the hostname "qbittorrentvpn" to connect Sonarr/Radarr.

2. Summary

qBittorrent will run in a default configuration with OpenVPN and Privoxy disabled. Some settings are already configured for you, plus a P2P Blocklist (credit: John Tyree).

See section 4 for more advanced configurations including how to configure your VPN.

3. Access Information

Protocol	Address	Notes
traefik**	qbittorrent:8098	Only for Internal App-to-App Communication
https	qbittorrent.domain.com	Traefik must be Deployed; Remote Servers
http	domain.com:8098	Poor Security Practice - Stop with PTS Port Guard
http	ipv4:8098	Ideal Only for Local Servers
privoxy†	qbittorrent:8118	Only for Internal App-to-App Communication

** Ideal for Apps to communicate between with one another. Click Here for more info!

† Privoxy allows your other Apps to use the qBittorrent's internet connection including its VPN configuration.

4. Configuration

Some essential settings are auto-configured by default when the app is deployed.

Login

The Default login is configured as follows:

Username	Password
admin	adminadmin

OpenVPN Configuration

The VPN is not enabled by default. To use it, the following must be performed:

1. Place your .ovpn file in /opt/appdata/qbittorrent/openvpn
2. Populate the VPN_USER variable with your VPN username.
3. Populate the VPN_PASS variable with your VPN password.
4. Set VPN_ENABLED to yes
5. (Optional) Configure additional OpenVPN settings with VPN_OPTIONS

If you cannot connect to your container after enabling VPN, check your logs. If you do not see [info] qBittorrent process listening on port 8098 then there may be a problem with your VPN configuration.

Jackett Plugin

qBittorrent can use Jackett as a search provider. See the instructions and download the search provider.

RSS

qBittorrent uses a feeds.json file located under opt/appdata/qbittorrent/qBittorrent/config/rss

The contents should be similar to the following example:

{
  "feeds": [
    {
      "name": "The New Books",
      "url": "http://rss.domain.example/author/some-guy.rss",
      "savepath": "/mnt/hd/books/Some Guy",
      "category": "Books",
      "filters": [
        {
          "field": "title",
          "regex": ".*epub.*"
         }
      ]
    },
    { ... }
  ]
}

Environmental Variables

Variable	Value	Notes
PUID	1000
PTSID	1000
UMASK	000
VPN_ENABLED	no	yes/no
VPN_USER	username	VPN username
VPN_PASS	password	VPN password
VPN_PROV	custom	custom, pia or airvpn
VPN_OPTIONS		Additional OpenVPN configuration
STRICT_PORT_FORWARD	no	yes/no
ENABLE_PRIVOXY	no	yes/no
LAN_NETWORK	172.18.0.0/16
NAME_SERVERS	1.1.1.1,84.200.69.80,37.235.1.174,185.121.177.177	Cloudflare, DNS.Watch, OpenDNS, OpenNIC
DEBUG	false	true/false
WEBUI_PORT	8098	Must match Internal port

Default Paths (configured automatically)

In case you are upgrading to PTS or change the paths and it's causing problems, here are the default paths to assist you! Categories do not need to specify a path, by default it uses downloadPath/categoryName when not set!

Path	Info
Temporary Download Folder	/mnt/incomplete/qbittorrent
Completed Download Folder	/mnt/downloads/qbittorrent
Saved Torrents Folder	/mnt/torrent
Torrent Watch Folder	/mnt/torrent/watch