An Ubuntu docker image running qBittorrent with openvpn

Base Docker Image

fullaxx/ubuntu-desktop

Software

• qBittorrent - A QT-based bittorrent application
• openvpn

Get the image from Docker Hub or build it locally

docker pull fullaxx/qbittorrent
docker build -t="fullaxx/qbittorrent" github.com/Fullaxx/qbittorrent

Volume Options

Data: All torrent data will use this volume
Drop your torrents/magnets in /srv/docker/qbt/data/autoload/
Also, your downloads will appear in /srv/docker/qbt/data/dl

-v /srv/docker/qbt/data:/data

Configuration: Any .ovpn files must be placed in /srv/docker/qbt/config/
Also, if qBittorrent.conf is found in /config, it will be copied to $HOME/.config/qBittorrent/ and used

-v /srv/docker/qbt/config:/config

VNC Options

Optional: Set Depth 16
Default: 24

-e VNCDEPTH='16'

Optional: Set 1920x1080 Resolution
Default: 1280x800

-e VNCRES='1920x1080'

Optional: Set Password Authentication
Default: No Authentication

-e VNCPASS='vncpass'

Optional: Set Read-Write and Read-Only password
Default: No Authentication

-e VNCPASS='vncpass' -e VNCPASSRO='readonly'

Optional: Run as a new non-root user
Default: root (UID: 0)

-e VNCUSER='guest' -e VNCUID='1000'

Optional: If you want your non-root user to be part of the users group
Default: same as VNCUSER and VNCUID
Pre-Req: VNCUSER and VNCUID must be set

-e VNCGROUP='users'

Optional: Define a new group for non-root user
Default: same as VNCUSER and VNCUID
Pre-Req: VNCUSER and VNCUID must be set

-e VNCGROUP='guests' -e VNCGID='1001'

Optional: Set a password for the VNCUSER account
Default: none and the account is locked
Pre-Req: VNCUSER and VNCUID must be set

-e ACCTPASS='mysecretpassword'

Optional: Set umask to define permission for new files
Default: 0022

-e VNCUMASK='0002'

OpenVPN Options

Optional: Wait 9 seconds for openvpn to initiate and connect before moving on
Default: 6 seconds

-e OVPNSLEEPTIME='9'

Use the file myconnection.ovpn to connect to an openvpn service
Default behavior is that openvpn will not run
Any .ovpn files must be placed in your openvpn volume (/srv/docker/qbt/config/)

-e OVPNCFG='myconnection.ovpn'

TimeZone Configuration

Set the timezone to be used inside the container
Default: UTC

-e TZ='Asia/Tokyo'
-e TZ='Europe/London'
-e TZ='America/Los_Angeles'
-e TZ='America/Denver'
-e TZ='America/Chicago'
-e TZ='America/New_York'

Shared Memory Modification (to support Web Browsers)

Increase the size of shared memory to prevent web browsers from crashing
Thanks to jlesage

--shm-size 2g

Persistant Configuration

Examples of how to keep your configuration persistant

-v /srv/docker/qbt/home/qbt:/root/.config/qBittorrent
-v /srv/docker/qbt/home/local:/root/.local
-v /srv/docker/qbt/home/mozilla:/root/.mozilla

Run the image

Run the image keeping your qBittorrent configuration

docker run -d \
-v /srv/docker/qbt/data:/data \
-p 127.0.0.1:5901:5901 fullaxx/qbittorrent

Run the image as a non-root user

docker run -d \
-e VNCUSER='guest' -e VNCUID='1000' \
-v /srv/docker/qbt/data:/data \
-p 127.0.0.1:5901:5901 fullaxx/qbittorrent

Run the image as a non-root user with custom group

docker run -d \
-e VNCUSER='guest' -e VNCUID='1000' \
-e VNCGROUP='guests' -e VNCGID='1001' \
-v /srv/docker/qbt/data:/data \
-p 127.0.0.1:5901:5901 fullaxx/qbittorrent

Run the image with OpenVPN
Make sure that your myconnection.ovpn file exists in /srv/docker/qbt/config/

docker run -d \
--cap-add=NET_ADMIN --device /dev/net/tun \
--sysctl net.ipv6.conf.all.disable_ipv6=0 \
-e OVPNCFG='myconnection.ovpn' \
-e OVPNSLEEPTIME='9' \
-e LOGFILE='mylog' \
-v /srv/docker/qbt/data:/data \
-v /srv/docker/qbt/config:/config \
-p 127.0.0.1:5901:5901 fullaxx/qbittorrent

Connect using vncviewer or a web browser

Use any standard VNC client to connect directly
For web access, check out noVNC to access your qBittorrent container with a web browser

vncviewer 127.0.0.1:5901

Posting Issues on Github

When posting issues, please provide the following:

• docker run line used to create the container
• output from docker logs
• screenshot showing the issue if not described in logs
• If OpenVPN related: read OPENVPN.md and provide contents of /var/log/openvpn/openvpn.log