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

removed resolv override env option. readme fixup

Browse Source
This commit is contained in:
Kristian Haugene 2015-09-10 22:37:03 +02:00
parent cb5b95ded9
commit 3c56a7ce08
3 changed files with 25 additions and 40 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
Dockerfile
View File

@ -1,6 +1,6 @@
# Transmission and OpenVPN
#
# Version 1.4
# Version 1.5
FROM ubuntu:14.04
MAINTAINER Kristian Haugene
@ -95,8 +95,7 @@ ENV OPENVPN_USERNAME=**None** \
"TRANSMISSION_UTP_ENABLED=true" \
"TRANSMISSION_WATCH_DIR=/data/watch" \
"TRANSMISSION_WATCH_DIR_ENABLED=true" \
"TRANSMISSION_HOME=/data/transmission-home" \
RESOLV_OVERRIDE=**None**
"TRANSMISSION_HOME=/data/transmission-home"
# Expose port and run
EXPOSE 9091

53
README.md
View File

@ -10,7 +10,8 @@ It bundles certificates and configurations for the following VPN providers:
When using PIA as provider it will update Transmission hourly with assigned open port. 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. To run the container use this command:
The container is available from the Docker registry and this is the simplest way to get it.
To run the container use this command:
```
$ docker run --privileged -d \
@ -30,7 +31,7 @@ Find available OpenVPN configurations by looking in the openvpn folder of the Gi
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 there will also be created a transmission-home folder under /data where Transmission state is stored.
By default a folder named transmission-home will also be created under /data, this is where Transmission stores its state.
### Required environment options
@ -44,13 +45,13 @@ By default there will also be created a transmission-home folder under /data whe
| Variable | Function | Example |
|----------|----------|-------|
|`OPENVPN_CONFIG` | Sets the OpenVPN endpoint to connect to. | `OPENVPN_CONFIG=UK Southampton`|
|`RESOLV_OVERRIDE` | The value of this variable will be written to `/etc/resolv.conf`. | `RESOLV_OVERRIDE=nameserver 8.8.8.8\nnameserver 8.8.4.4\n`|
### Transmission configuration options
You may override transmission options by setting the appropriate environment variable.
The environment variables are the same name as used in the transmission settings.json file and follow the format given in these examples:
The environment variables are the same name as used in the transmission settings.json file
and follow the format given in these examples:
| Transmission variable name | Environment variable name |
|----------------------------|---------------------------|
@ -61,14 +62,17 @@ The environment variables are the same name as used in the transmission settings
As you can see the variables are prefixed with `TRANSMISSION_`, the variable is capitalized, and `-` is converted to `_`.
PS: `TRANSMISSION_BIND_ADDRESS_IPV4` will be overridden to the IP assigned to your OpenVPN tunnel interface. This is to prevent leaking of the host IP.
PS: `TRANSMISSION_BIND_ADDRESS_IPV4` will be overridden to the IP assigned to your OpenVPN tunnel interface.
This is to prevent leaking the host IP.
## Access the WebUI
But what's going on? My http://my-host:9091 isn't responding?
This is because the VPN is active, and since docker is running in a different ip range than your client the response to your request will be treated as "non-local" traffic and therefore be routed out through the VPN interface.
This is because the VPN is active, and since docker is running in a different ip range than your client the response
to your request will be treated as "non-local" traffic and therefore be routed out through the VPN interface.
### How to fix this
There are several ways to fix this. You can pipe and do fancy iptables or ip route configurations on the host and in the Docker image. But I found that the simplest solution is just to proxy my traffic. Start a Nginx container like this:
There are several ways to fix this. You can pipe and do fancy iptables or ip route configurations on the host and in
the container. But I found that the simplest solution is just to proxy my traffic. Start an nginx container like this:
```
$ docker run -d \
@ -96,10 +100,15 @@ http {
Your Transmission WebUI should now be avaliable at "your.host.ip.addr:8080/transmission/web/".
Change the port in the docker run command if 8080 is not suitable for you.
### Known issues
Some have encountered problems with DNS resolving inside the docker container. This causes trouble because OpenVPN will not be able to resolve the host to connect to. If you have this problem, please refer to issue #4 on GitHib and you might want to use the `RESOLV_OVERRIDE` flag described in "Network configuration options"
## Known issues
Some have encountered problems with DNS resolving inside the docker container.
This causes trouble because OpenVPN will not be able to resolve the host to connect to.
If you have this problem use dockers --dns flag to override the resolv.conf of the container.
For example use googles dns servers by adding --dns 8.8.8.8 --dns 8.8.4.4 as parameters to the usual run command.
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.
Using the latest stable verison of Docker is always recommended. Support for older version is on a best-effort basis.
## Building the container yourself
To build this container, clone the repository and cd into it.
@ -107,7 +116,7 @@ To build this container, clone the repository and cd into it.
### Build it:
```
$ cd /repo/location/docker-transmission-openvpn
$ docker build -t docker-transmission-openvpn .
$ docker build -t transmission-openvpn .
```
### Run it:
```
@ -118,29 +127,13 @@ $ docker run --privileged -d \
-e "OPENVPN_USERNAME=user" \
-e "OPENVPN_PASSWORD=pass" \
-p 9091:9091 \
docker-transmission-openvpn
transmission-openvpn
```
This will start a container as described in the "Run container from Docker registry" section.
## What if I want to run the container interactively.
If you want do have access inside the container while running you have two choices. To have a look inside an already running container, use docker exec to get a terminal inside the container.
```
$ docker ps | grep transmission-openvpn | awk '{print $1}' // Prints container id
$ af4dd385916d
$ docker exec -it af4dd bash
```
If you want to start the container without it starting OpenVPN on boot, then run the image without daemonizing and use bash as entrypoint.
```
$ docker run --privileged -it transmission-openvpn bash
```
From there you can start the service yourself, or do whatever (probably developer-related) you came to do.
## Controlling Transmission remotely
The container exposes /config as a volume. This is the directory where the supplied transmission and OpenVPN credentials will be stored.
If you have transmission authentication enabled and want scripts in another container to access and control the transmission-daemon, this can be a handy way to access the credentials.
If you have transmission authentication enabled and want scripts in another container to access and
control the transmission-daemon, this can be a handy way to access the credentials.
For example, another container may pause or restrict transmission speeds while the server is streaming video.

7
openvpn/start.sh
View File

@ -34,13 +34,6 @@ else
OPENVPN_CONFIG=/etc/openvpn/$vpn_provider/default.ovpn
fi
# override resolv.conf
if [ "$RESOLV_OVERRIDE" != "**None**" ];
then
echo "Overriding resolv.conf..."
printf "$RESOLV_OVERRIDE" > /etc/resolv.conf
fi
# add OpenVPN user/pass
if [ "${OPENVPN_USERNAME}" = "**None**" ] || [ "${OPENVPN_PASSWORD}" = "**None**" ] ; then
echo "PIA credentials not set. Exiting."