Updated alpha to be more like master
This commit is contained in:
DyonR
parent
a5acdca41a
commit
783612ea5a
@ -1,3 +1,4 @@
|
||||
# qBittorrent, OpenVPN and WireGuard, qbittorrentvpn
|
||||
FROM debian:bullseye-slim
|
||||
|
||||
WORKDIR /opt
|
||||
@ -194,6 +195,9 @@ RUN echo "deb http://deb.debian.org/debian/ bullseye non-free" > /etc/apt/source
|
||||
/tmp/* \
|
||||
/var/tmp/*
|
||||
|
||||
# Remove src_valid_mark from wg-quick
|
||||
RUN sed -i /net\.ipv4\.conf\.all\.src_valid_mark/d `which wg-quick`
|
||||
|
||||
VOLUME /config /downloads
|
||||
|
||||
ADD openvpn/ /etc/openvpn/
|
||||
|
||||
39
README.md
39
README.md
@ -7,7 +7,7 @@ Docker container which runs the latest [qBittorrent](https://github.com/qbittorr
|
||||
[preview]: https://raw.githubusercontent.com/DyonR/docker-templates/master/Screenshots/qbittorrentvpn/qbittorrentvpn-webui.png "qBittorrent WebUI"
|
||||
![alt text][preview]
|
||||
|
||||
## Docker Features
|
||||
# Docker Features
|
||||
* Base: Debian bullseye-slim
|
||||
* [qBittorrent](https://github.com/qbittorrent/qBittorrent) compiled from source
|
||||
* [libtorrent](https://github.com/arvidn/libtorrent) compiled from source
|
||||
@ -19,22 +19,34 @@ Docker container which runs the latest [qBittorrent](https://github.com/qbittorr
|
||||
* Created with [Unraid](https://unraid.net/) in mind
|
||||
* BitTorrent port 8999 exposed by default
|
||||
|
||||
# Run container from Docker registry
|
||||
## Run container from Docker registry
|
||||
The container is available from the Docker registry and this is the simplest way to get it
|
||||
To run the container use this command, with additional parameters, please refer to the Variables, Volumes, and Ports section:
|
||||
|
||||
```
|
||||
$ docker run --privileged -d \
|
||||
$ docker run -d \
|
||||
-v /your/config/path/:/config \
|
||||
-v /your/downloads/path/:/downloads \
|
||||
-e "VPN_ENABLED=yes" \
|
||||
-e "VPN_TYPE=wireguard" \
|
||||
-e "LAN_NETWORK=192.168.0.0/24" \
|
||||
-p 8080:8080 \
|
||||
--cap-add NET_ADMIN \
|
||||
--sysctl "net.ipv4.conf.all.src_valid_mark=1" \
|
||||
--restart unless-stopped \
|
||||
dyonr/qbittorrentvpn
|
||||
```
|
||||
|
||||
## Docker Tags
|
||||
| Tag | Description |
|
||||
|----------|----------|
|
||||
| `dyonr/qbittorrentvpn:latest` | The latest version of qBittorrent with libtorrent 1_x_x |
|
||||
| `dyonr/qbittorrentvpn:rc_2_0` | The latest version of qBittorrent with libtorrent 2_x_x |
|
||||
| `dyonr/qbittorrentvpn:legacy_iptables` | The latest version of qBittorrent, libtorrent 1_x_x and an experimental feature to fix problems with QNAP NAS systems, [Issue #25](https://github.com/DyonR/docker-qbittorrentvpn/issues/25) |
|
||||
| `dyonr/qbittorrentvpn:alpha` | The latest alpha version of qBittorrent with libtorrent 2_0, incase you feel like testing new features |
|
||||
| `dyonr/qbittorrentvpn:dev` | This branch is used for testing new Docker features or improvements before merging it to the main branch |
|
||||
| `dyonr/qbittorrentvpn:v4_2_x` | (Legacy) qBittorrent version 4.2.x with libtorrent 1_x_x |
|
||||
|
||||
# Variables, Volumes, and Ports
|
||||
## Environment Variables
|
||||
| Variable | Required | Function | Example | Default |
|
||||
@ -44,6 +56,7 @@ $ docker run --privileged -d \
|
||||
|`VPN_USERNAME`| No | If username and password provided, configures ovpn file automatically |`VPN_USERNAME=ad8f64c02a2de`||
|
||||
|`VPN_PASSWORD`| No | If username and password provided, configures ovpn file automatically |`VPN_PASSWORD=ac98df79ed7fb`||
|
||||
|`LAN_NETWORK`| Yes (atleast one) | Comma delimited local Network's with CIDR notation |`LAN_NETWORK=192.168.0.0/24,10.10.0.0/24`||
|
||||
|`LEGACY_IPTABLES`| No | Use `iptables (legacy)` instead of `iptables (nf_tables)` |`LEGACY_IPTABLES=yes`||
|
||||
|`ENABLE_SSL`| No | Let the container handle SSL (yes/no)? |`ENABLE_SSL=yes`|`yes`|
|
||||
|`NAME_SERVERS`| No | Comma delimited name servers |`NAME_SERVERS=1.1.1.1,1.0.0.1`|`1.1.1.1,1.0.0.1`|
|
||||
|`PUID`| No | UID applied to /config files and /downloads |`PUID=99`|`99`|
|
||||
@ -79,10 +92,18 @@ Access https://IPADDRESS:PORT from a browser on the same network. (for example:
|
||||
|`password`| `adminadmin` |
|
||||
|
||||
# How to use WireGuard
|
||||
The container will fail to boot if `VPN_ENABLED` is set and there is no valid .conf file present in the /config/wireguard directory. Drop a .conf file from your VPN provider into /config/wireguard and start the container again. The file must have the name `wg0.conf`.
|
||||
The container will fail to boot if `VPN_ENABLED` is set and there is no valid .conf file present in the /config/wireguard directory. Drop a .conf file from your VPN provider into /config/wireguard and start the container again. The file must have the name `wg0.conf`, or it will fail to start.
|
||||
|
||||
## WireGuard IPv6 issues
|
||||
If you use WireGuard and also have IPv6 enabled, it is necessary to add the IPv6 range to the `LAN_NETWORK` environment variable.
|
||||
Additionally the parameter `--sysctl net.ipv6.conf.all.disable_ipv6=0` also must be added to the `docker run` command, or to the "Extra Parameters" in Unraid.
|
||||
The full Unraid `Extra Parameters` would be: `--restart unless-stopped --sysctl net.ipv6.conf.all.disable_ipv6=0"`
|
||||
If you do not do this, the container will keep on stopping with the error `RTNETLINK answers permission denied`.
|
||||
Since I do not have IPv6, I am did not test.
|
||||
Thanks to [mchangrh](https://github.com/mchangrh) / [Issue #49](https://github.com/DyonR/docker-qbittorrentvpn/issues/49)
|
||||
|
||||
# How to use OpenVPN
|
||||
The container will fail to boot if `VPN_ENABLED` is set and there is no valid .ovpn file present in the /config/openvpn directory. Drop a .ovpn file from your VPN provider into /config/openvpn and start the container again. You may need to edit the ovpn configuration file to load your VPN credentials from a file by setting `auth-user-pass`.
|
||||
The container will fail to boot if `VPN_ENABLED` is set and there is no valid .ovpn file present in the /config/openvpn directory. Drop a .ovpn file from your VPN provider into /config/openvpn (if necessary with additional files like certificates) and start the container again. You may need to edit the ovpn configuration file to load your VPN credentials from a file by setting `auth-user-pass`.
|
||||
|
||||
**Note:** The script will use the first ovpn file it finds in the /config/openvpn directory. Adding multiple ovpn files will not start multiple VPN connections.
|
||||
|
||||
@ -103,11 +124,11 @@ id <username>
|
||||
```
|
||||
|
||||
# Issues
|
||||
If you are having issues with this container please submit an issue on GitHub.
|
||||
Please provide logs, docker version and other information that can simplify reproducing the issue.
|
||||
Using the latest stable verison of Docker is always recommended. Support for older version is on a best-effort basis.
|
||||
If you are having issues with this container please submit an issue on GitHub.
|
||||
Please provide logs, Docker version and other information that can simplify reproducing the issue.
|
||||
If possible, always use the most up to date version of Docker, you operating system, kernel and the container itself. Support is always a best-effort basis.
|
||||
|
||||
### Credits:
|
||||
### Credits:
|
||||
[MarkusMcNugen/docker-qBittorrentvpn](https://github.com/MarkusMcNugen/docker-qBittorrentvpn)
|
||||
[DyonR/jackettvpn](https://github.com/DyonR/jackettvpn)
|
||||
This projects originates from MarkusMcNugen/docker-qBittorrentvpn, but forking was not possible since DyonR/jackettvpn uses the fork already.
|
||||
Loading…
x
Reference in New Issue
Block a user