diff --git a/wiki/bittorrent.md b/wiki/bittorrent.md index fba87f2..4a14ace 100644 --- a/wiki/bittorrent.md +++ b/wiki/bittorrent.md @@ -10,7 +10,8 @@ file, seeding describes the download followed by also uploading it. There are various clients to use for BitTorrent down- and uploading. The list below shows clients with an existing entry in this wiki. -- [Transmission](/wiki/transmission.md) +- [Transmission](/wiki/transmission.md) is an easy to use client +- [qBittorrent](/wiki/qbittorrent.md) is a very feature rich client ## Personal Video Recorders diff --git a/wiki/docker-images/dyonr_-_qbittorrentvpn.md b/wiki/docker-images/dyonr_-_qbittorrentvpn.md new file mode 100644 index 0000000..0f3ce94 --- /dev/null +++ b/wiki/docker-images/dyonr_-_qbittorrentvpn.md @@ -0,0 +1,73 @@ +# dyonr - qbittorrentvpn + +This is a [Docker](/wiki/docker.md) container for a +[qBittorrent](../qbittorrent.md) server that is connected to the internet via +an [openVPN tunnel](/wiki/vpn.md). +The official container and documentation was made by +[dyonr](https://github.com/DyonR/docker-qbittorrentvpn). + +## Set-up + +Create the file `rebuild.sh`. +Change the settings according to your needs and run `./rebuild.sh` afterwards. + +## Environment-variables + +Set the following variables with the -e tag. + +| Name | Usage | Default | +| ------------------- | --------------------------- | ------- | +| `VPN_ENABLE` | Enable VPN | ` ` | +| `VPN_USERNAME` | Username for OpenVPN | ` ` | +| `VPN_PASSWORD` | Password for OpenVPN | ` ` | +| `LAN_NETWORK` | Subnet of the local network | ` ` | + +## Volumes + +Set the following volumes with the -v tag. + +| Outside mount/volume name | Container mount | Description | +| ------------------------- | ------------------- | ----------------------- | +| `qbittorrentvpn_config` | `/config` | Configuration files | +| `qbittorrentvpn_data` | `/downloads` | Storage for data | + +## Ports + +Set the following ports with the -p tag. + +| Container Port | Recommended outside port | Protocol | Description | +| -------------- | ------------------------ | -------- | ----------- | +| `9091` | `8080` | TCP | WebUI | + +## Additional + +There are some special variables to set. + +| Flag | Usage | +| ----------- | ---------------------- | +| `--cap-add` | add linux capabilities | +| `--device` | connect devices | +| `--sysctl` | configure systemctl | + +## rebuild.sh + +```sh +#!/bin/sh +docker stop qbittorrentvpn +docker rm qbittorrentvpn +docker pull dyonr/qbittorrentvpn +docker run --name qbittorrentvpn \ + --restart unless-stopped \ + -p 9091:8080 \ + -v qbittorrentvpn_config:/config \ + -v qbittorrentvpn_data:/downloads \ + -e "VPN_ENABLED=yes" \ + -e "VPN_TYPE=openvpn" \ + -e "VPN_USERNAME=username" \ + -e "VPN_PASSWORD=password" \ + -e "LAN_NETWORK=192.168.0.0/16" \ + --cap-add NET_ADMIN \ + --device /dev/net/tun \ + --sysctl "net.ipv4.conf.all.src_valid_mark=1" \ + -d dyonr/qbittorrentvpn +``` diff --git a/wiki/qbittorrent.md b/wiki/qbittorrent.md new file mode 100644 index 0000000..5c7af47 --- /dev/null +++ b/wiki/qbittorrent.md @@ -0,0 +1,11 @@ +# qBittorrent + +[qBittorrent](https://www.qbittorrent.org/) is a cross platform free and +open-source [BitTorrent client](/wiki/bittorrent.md#clients). + +## Setup + +The software can be setup via [Docker](/wiki/docker.md) with the +[dyonr image](/wiki/docker-images/dyonr_-_qbittorrentvpn.md) that +includes an [OpenVPN](/wiki/vpn.md#openvpn) tunnel. +