Github/docker-qBittorrentvpn
1
0
Fork 0
mirror of https://github.com/MarkusMcNugen/docker-qBittorrentvpn synced 2024-11-14 22:55:11 +00:00
Code Issues Projects Releases Wiki Activity

Update README.md

Browse Source
This commit is contained in:
MarkusMcNugen 2018-02-02 19:59:48 -05:00 committed by GitHub
parent cf15d41301
commit 8181782cda
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 7 additions and 27 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
README.md
View File

@ -1,19 +1,5 @@
# qBittorrent with WebUI and OpenVPN
Docker container which runs qBittorrent torrent client with WebUI while connecting to OpenVPN.
It bundles certificates and configurations for the following VPN providers:
* Private Internet Access
* BTGuard
* TigerVPN
* FrootVPN
* TorGuard
* NordVPN
* UsenetServerVPN
* IPVanish
* Anonine
* HideMe
* PureVPN
When using PIA as provider it will update Transmission hourly with assigned open qBittorrent. Please read the instructions below.
## Run container from Docker registry
The container is available from the Docker registry and this is the simplest way to get it.
@ -21,24 +7,18 @@ To run the container use this command:
```
$ docker run --privileged -d \
-v /your/storage/path/:/data \
-e "OPENVPN_PROVIDER=PIA" \
-e "OPENVPN_CONFIG=Netherlands" \
-v /your/docker/config/path/:/config \
-v /your/downloads/path/:/downloads \
-e "OPENVPN_USERNAME=user" \
-e "OPENVPN_PASSWORD=pass" \
-p 9091:9091 \
hayduck/qbittorrent-openvpn
-p 8080:8080 \
markusmcnugen/qbittorrentvpn
```
You must set the environment variables `OPENVPN_PROVIDER`, `OPENVPN_USERNAME` and `OPENVPN_PASSWORD` to provide basic connection details.
The `OPENVPN_CONFIG` is an optional variable. If no config is given, a default config will be selected for the provider you have chosen.
Find available OpenVPN configurations by looking in the openvpn folder of the GitHub repository.
As you can see, the container also expects a data volume to be mounted.
This is where Transmission will store your downloads, incomplete downloads and look for a watch directory for new .torrent files.
By default a folder named transmission-home will also be created under /data, this is where Transmission stores its state.
You must set the environment variables `OPENVPN_USERNAME` and `OPENVPN_PASSWORD` to provide basic connection details.
As you can see, the container also expects a downloads volume to be mounted.
This is where qBittorrent will store your downloads, incomplete downloads and look for a watch directory for new .torrent files.
### Required environment options
| Variable | Function | Example |