diff --git a/Dockerfile b/Dockerfile index 9fa4160..cab1379 100644 --- a/Dockerfile +++ b/Dockerfile @@ -1,6 +1,6 @@ # Transmission and OpenVPN # -# Version 1.1 +# Version 1.2 FROM ubuntu:14.04 MAINTAINER Kristian Haugene @@ -18,11 +18,12 @@ RUN apt-get update \ && curl -L https://github.com/jwilder/dockerize/releases/download/v0.0.2/dockerize-linux-amd64-v0.0.2.tar.gz | tar -C /usr/local/bin -xzv # Add configuration and scripts -ADD openvpn/* /etc/openvpn/ -ADD transmission/* /etc/transmission-daemon/ +ADD openvpn/ /etc/openvpn/ +ADD transmission/ /etc/transmission/ -ENV PIA_USERNAME=**None** \ - PIA_PASSWORD=**None** \ +ENV OPENVPN_USERNAME=**None** \ + OPENVPN_PASSWORD=**None** \ + OPENVPN_PROVIDER=PIA \ "TRANSMISSION_ALT_SPEED_DOWN=50" \ "TRANSMISSION_ALT_SPEED_ENABLED=false" \ "TRANSMISSION_ALT_SPEED_TIME_BEGIN=540" \ diff --git a/README.md b/README.md index 0d45d7e..698609f 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,8 @@ -Private Internet Access OpenVPN - Transmission -=== -This Docker container lets you run Transmission with WebUI while connecting to PIA VPN. It updates Transmission hourly with assigned open port from PIA. Please read the instructions below. +# Transmission with WebUI and OpenVPN +This Docker container lets you run Transmission with WebUI while connecting to either BTGUARD or PIA OpenVPN. +When using PIA as provider it will update Transmission hourly with assigned open port. Please read the instructions below. + +NB: Support for BTGUARD is only available with the dev tag for now. Please use haugene/transmission-openvpn:dev if you want to use BTGUARD as provider. See readme for the different branches on GitHub. ## 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: @@ -8,38 +10,33 @@ The container is available from the Docker registry and this is the simplest way ``` $ docker run --privileged -d \ -v /your/storage/path/:/data \ - -e "PIA_USERNAME=user" \ - -e "PIA_PASSWORD=pass" \ + -e "OPENVPN_PROVIDER=PIA" \ + -e "OPENVPN_CONFIG=Netherlands" \ + -e "OPENVPN_USERNAME=user" \ + -e "OPENVPN_PASSWORD=pass" \ -p 9091:9091 \ haugene/transmission-openvpn ``` -or you could optionally specify which vpn server to use by setting an environment variable to one of the ovpn configs avaliable [in this folder](https://github.com/haugene/docker-transmission-openvpn/tree/master/piaconfig). +The `OPENVPN_PROVIDER` and `OPENVPN_CONFIG` are optional variables. If no provider is given, it will default to PIA. If no config is given, a default config will be selected for the provider you have chosen. +The only mandatory environment variables are your OpenVPN username and password. You must set the environment variables `OPENVPN_USERNAME` and `OPENVPN_PASSWORD` to the credentials given by your OpenVPN provider. -``` -$ docker run --privileged -d \ - -v /your/storage/path/:/data \ - -e "PIA_USERNAME=user" \ - -e "PIA_PASSWORD=pass" \ - -p 9091:9091 \ - -e "OPEN_VPN_CONFIG=US West" \ - haugene/transmission-openvpn -``` +Find the OpenVPN configurations avaliable by looking in the openvpn folder of the GitHub repository. -As you can see, the container expects a data volume to be mounted. It is used for storing your downloads from Transmission. The container comes with a default Transmission `settings.json` file that expects the folders `completed`, `incomplete`, and `watch` to be present in /your/storage/path (aka /data). This is where Transmission will store your downloads, incomplete downloads and a watch directory to look for new .torrent files. +As you can see, the container also expects a data volume to be mounted. It is used for storing your downloads from Transmission. The container comes with a default Transmission `settings.json` file that expects the folders `completed`, `incomplete`, and `watch` to be present in /your/storage/path (aka /data). This is where Transmission will store your downloads, incomplete downloads and a watch directory to look for new .torrent files. -The only mandatory configuration is to set two environment variables for your PIA username and password. You must set the environment variables `PIA_USERNAME` and `PIA_PASSWORD` to your login credentials. The container will connect to the Private Internet Access VPN servers in Netherlands by default. ### Required environment options | Variable | Function | Example | |----------|----------|-------| -|`PIA_USERNAME`|Your login username for PIA|`PIA_USERNAME=asdf`| -|`PIA_PASSWORD`|Your login password for PIA|`PIA_PASSWORD=asdf`| +|`OPENVPN_USERNAME`|Your OpenVPN username |`OPENVPN_USERNAME=asdf`| +|`OPENVPN_PASSWORD`|Your OpenVPN password |`OPENVPN_PASSWORD=asdf`| ### Network configuration options | Variable | Function | Example | |----------|----------|-------| -|`OPEN_VPN_CONFIG` | Sets the PIA endpoint to connect to. | `OPEN_VPN_CONFIG=UK Southampton`| +|`OPENVPN_PROVIDER` | Sets the OpenVPN provider to use. | `OPENVPN_PROVIDER=BTGUARD`| +|`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 @@ -65,22 +62,26 @@ 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 docker-transmission-openvpn . ``` ### Run it: ``` $ docker run --privileged -d \ -v /your/storage/path/:/data \ - -e "PIA_USERNAME=user" \ - -e "PIA_PASSWORD=pass" \ + -e "OPENVPN_PROVIDER=PIA" \ + -e "OPENVPN_CONFIG=Netherlands" \ + -e "OPENVPN_USERNAME=user" \ + -e "OPENVPN_PASSWORD=pass" \ -p 9091:9091 \ docker-transmission-openvpn ``` -As described in the "Run container from Docker registry" section, this will start a container with default settings. This means that you should have the folders "completed, incomplete and watch" in /your/storage/path, and pia-credentials.txt in /your/config/path. +This will start a container as described in the "Run container from Docker registry" section. This means that you should have the folders "completed, incomplete and watch" in /your/storage/path, and pia-credentials.txt in /your/config/path. -### Issues -If you are having some issues running the local build then please ensure you are using the latest version of docker. Using the latest stable verison is always recommended. Support for older version is on a best-effort basis. +### 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" + +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. ## Access the WebUI But what's going on? My http://my-host:9091 isn't responding? @@ -90,8 +91,12 @@ This is because the VPN is active, and since docker is running in a different ip 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: ``` -$ docker run -d -v /path/to/nginx.conf:/etc/nginx/nginx.conf:ro -p 8080:8080 nginx +$ docker run -d \ + -v /path/to/nginx.conf:/etc/nginx/nginx.conf:ro \ + -p 8080:8080 \ + nginx ``` + Where /path/to/nginx.conf has this content: ``` diff --git a/openvpn/btguard/btguard.ca.crt b/openvpn/btguard/btguard.ca.crt new file mode 100644 index 0000000..d3c3850 --- /dev/null +++ b/openvpn/btguard/btguard.ca.crt @@ -0,0 +1,21 @@ +-----BEGIN CERTIFICATE----- +MIIDcjCCAtugAwIBAgIJAPKjuBleHokmMA0GCSqGSIb3DQEBBQUAMIGDMQswCQYD +VQQGEwJERTEVMBMGA1UECBMMSGVzc2UtTmFzc2F1MRIwEAYDVQQHEwlGcmFua2Z1 +cnQxEDAOBgNVBAoTB0JUR3VhcmQxEzARBgNVBAMTCkJUR3VhcmQgQ0ExIjAgBgkq +hkiG9w0BCQEWE3N1cHBvcnRAYnRndWFyZC5jb20wHhcNMTAwODA3MDc0NTA5WhcN +MjAwODA0MDc0NTA5WjCBgzELMAkGA1UEBhMCREUxFTATBgNVBAgTDEhlc3NlLU5h +c3NhdTESMBAGA1UEBxMJRnJhbmtmdXJ0MRAwDgYDVQQKEwdCVEd1YXJkMRMwEQYD +VQQDEwpCVEd1YXJkIENBMSIwIAYJKoZIhvcNAQkBFhNzdXBwb3J0QGJ0Z3VhcmQu +Y29tMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQC4cBR6VLQICqdpTsjosIQ5 +9elQZSRNQFaxWW3MeRC1xpJqjkbLJ9B9IO/Q/UyOa4a3qYHg8rI43wIF/RR6bwNX +3sZ5w6TrdVBk0DFZq6lDQ8/4Kpg1dKbdAgJjvtxiyrHWFtB0jYVGTlxwBSPflc2J +RZDMAVVj83gQh8ODJeGjnwIDAQABo4HrMIHoMB0GA1UdDgQWBBQCj1U+EICMz8hF +++KZ8Ld1vR0sqTCBuAYDVR0jBIGwMIGtgBQCj1U+EICMz8hF++KZ8Ld1vR0sqaGB +iaSBhjCBgzELMAkGA1UEBhMCREUxFTATBgNVBAgTDEhlc3NlLU5hc3NhdTESMBAG +A1UEBxMJRnJhbmtmdXJ0MRAwDgYDVQQKEwdCVEd1YXJkMRMwEQYDVQQDEwpCVEd1 +YXJkIENBMSIwIAYJKoZIhvcNAQkBFhNzdXBwb3J0QGJ0Z3VhcmQuY29tggkA8qO4 +GV4eiSYwDAYDVR0TBAUwAwEB/zANBgkqhkiG9w0BAQUFAAOBgQAgVeYTxvAonucE +qWloEvzCCUWs8bS/HJ6M85WzG7FPNAXx2QbWwN3EMwKxtGc7QF8f+APoMukzsvd2 +vuI+1n0YwtD12cWMM9PLV2FhA2B+ajzssBTgvrbtX/SzKt0//lzrBp5Gyo6T/vO5 +9KRb6DVfVWfB76+DLpTf9f3SLTgzKw== +-----END CERTIFICATE----- diff --git a/openvpn/btguard/btguard.ovpn b/openvpn/btguard/btguard.ovpn new file mode 100644 index 0000000..539dd54 --- /dev/null +++ b/openvpn/btguard/btguard.ovpn @@ -0,0 +1,21 @@ +client +dev tun0 +proto udp +remote vpn.btguard.com 1194 +resolv-retry infinite +nobind +persist-key +persist-tun +verb 3 +mute 3 +mute-replay-warnings +float +reneg-sec 0 + +ca /etc/openvpn/btguard/btguard.ca.crt +auth-user-pass /config/openvpn-credentials.txt + +# OpenVPN control startup and shut down of transmission +script-security 2 +up /etc/transmission/start.sh +down /etc/transmission/stop.sh diff --git a/openvpn/btguard/default.ovpn b/openvpn/btguard/default.ovpn new file mode 120000 index 0000000..f85b2c0 --- /dev/null +++ b/openvpn/btguard/default.ovpn @@ -0,0 +1 @@ +btguard.ovpn \ No newline at end of file diff --git a/openvpn/AU Melbourne.ovpn b/openvpn/pia/AU Melbourne.ovpn similarity index 60% rename from openvpn/AU Melbourne.ovpn rename to openvpn/pia/AU Melbourne.ovpn index a32dffa..f7ae5dd 100644 --- a/openvpn/AU Melbourne.ovpn +++ b/openvpn/pia/AU Melbourne.ovpn @@ -12,11 +12,11 @@ comp-lzo verb 1 reneg-sec 0 -ca /etc/openvpn/ca.crt -auth-user-pass /config/pia-credentials.txt -crl-verify /etc/openvpn/crl.pem +ca /etc/openvpn/pia/ca.crt +auth-user-pass /config/openvpn-credentials.txt +crl-verify /etc/openvpn/pia/crl.pem # OpenVPN control startup and shut down of transmission script-security 2 -up /etc/transmission-daemon/start.sh -down /etc/transmission-daemon/stop.sh +up /etc/transmission/start.sh +down /etc/transmission/stop.sh diff --git a/openvpn/AU Sydney.ovpn b/openvpn/pia/AU Sydney.ovpn similarity index 59% rename from openvpn/AU Sydney.ovpn rename to openvpn/pia/AU Sydney.ovpn index 04fb526..e322b05 100644 --- a/openvpn/AU Sydney.ovpn +++ b/openvpn/pia/AU Sydney.ovpn @@ -12,11 +12,11 @@ comp-lzo verb 1 reneg-sec 0 -ca /etc/openvpn/ca.crt -auth-user-pass /config/pia-credentials.txt -crl-verify /etc/openvpn/crl.pem +ca /etc/openvpn/pia/ca.crt +auth-user-pass /config/openvpn-credentials.txt +crl-verify /etc/openvpn/pia/crl.pem # OpenVPN control startup and shut down of transmission script-security 2 -up /etc/transmission-daemon/start.sh -down /etc/transmission-daemon/stop.sh +up /etc/transmission/start.sh +down /etc/transmission/stop.sh diff --git a/openvpn/CA North York.ovpn b/openvpn/pia/CA North York.ovpn similarity index 59% rename from openvpn/CA North York.ovpn rename to openvpn/pia/CA North York.ovpn index 491482e..95c4f1d 100644 --- a/openvpn/CA North York.ovpn +++ b/openvpn/pia/CA North York.ovpn @@ -12,11 +12,11 @@ comp-lzo verb 1 reneg-sec 0 -ca /etc/openvpn/ca.crt -auth-user-pass /config/pia-credentials.txt -crl-verify /etc/openvpn/crl.pem +ca /etc/openvpn/pia/ca.crt +auth-user-pass /config/openvpn-credentials.txt +crl-verify /etc/openvpn/pia/crl.pem # OpenVPN control startup and shut down of transmission script-security 2 -up /etc/transmission-daemon/start.sh -down /etc/transmission-daemon/stop.sh +up /etc/transmission/start.sh +down /etc/transmission/stop.sh diff --git a/openvpn/CA Toronto.ovpn b/openvpn/pia/CA Toronto.ovpn similarity index 60% rename from openvpn/CA Toronto.ovpn rename to openvpn/pia/CA Toronto.ovpn index b52fa62..ad7542a 100644 --- a/openvpn/CA Toronto.ovpn +++ b/openvpn/pia/CA Toronto.ovpn @@ -12,11 +12,11 @@ comp-lzo verb 1 reneg-sec 0 -ca /etc/openvpn/ca.crt -auth-user-pass /config/pia-credentials.txt -crl-verify /etc/openvpn/crl.pem +ca /etc/openvpn/pia/ca.crt +auth-user-pass /config/openvpn-credentials.txt +crl-verify /etc/openvpn/pia/crl.pem # OpenVPN control startup and shut down of transmission script-security 2 -up /etc/transmission-daemon/start.sh -down /etc/transmission-daemon/stop.sh +up /etc/transmission/start.sh +down /etc/transmission/stop.sh diff --git a/openvpn/France.ovpn b/openvpn/pia/France.ovpn similarity index 60% rename from openvpn/France.ovpn rename to openvpn/pia/France.ovpn index b311bf0..cb86432 100644 --- a/openvpn/France.ovpn +++ b/openvpn/pia/France.ovpn @@ -12,11 +12,11 @@ comp-lzo verb 1 reneg-sec 0 -ca /etc/openvpn/ca.crt -auth-user-pass /config/pia-credentials.txt -crl-verify /etc/openvpn/crl.pem +ca /etc/openvpn/pia/ca.crt +auth-user-pass /config/openvpn-credentials.txt +crl-verify /etc/openvpn/pia/crl.pem # OpenVPN control startup and shut down of transmission script-security 2 -up /etc/transmission-daemon/start.sh -down /etc/transmission-daemon/stop.sh +up /etc/transmission/start.sh +down /etc/transmission/stop.sh diff --git a/openvpn/Germany.ovpn b/openvpn/pia/Germany.ovpn similarity index 60% rename from openvpn/Germany.ovpn rename to openvpn/pia/Germany.ovpn index c496a73..2e9b203 100644 --- a/openvpn/Germany.ovpn +++ b/openvpn/pia/Germany.ovpn @@ -12,11 +12,11 @@ comp-lzo verb 1 reneg-sec 0 -ca /etc/openvpn/ca.crt -auth-user-pass /config/pia-credentials.txt -crl-verify /etc/openvpn/crl.pem +ca /etc/openvpn/pia/ca.crt +auth-user-pass /config/openvpn-credentials.txt +crl-verify /etc/openvpn/pia/crl.pem # OpenVPN control startup and shut down of transmission script-security 2 -up /etc/transmission-daemon/start.sh -down /etc/transmission-daemon/stop.sh +up /etc/transmission/start.sh +down /etc/transmission/stop.sh diff --git a/openvpn/Hong Kong.ovpn b/openvpn/pia/Hong Kong.ovpn similarity index 59% rename from openvpn/Hong Kong.ovpn rename to openvpn/pia/Hong Kong.ovpn index 328cfbf..63b4c54 100644 --- a/openvpn/Hong Kong.ovpn +++ b/openvpn/pia/Hong Kong.ovpn @@ -12,11 +12,11 @@ comp-lzo verb 1 reneg-sec 0 -ca /etc/openvpn/ca.crt -auth-user-pass /config/pia-credentials.txt -crl-verify /etc/openvpn/crl.pem +ca /etc/openvpn/pia/ca.crt +auth-user-pass /config/openvpn-credentials.txt +crl-verify /etc/openvpn/pia/crl.pem # OpenVPN control startup and shut down of transmission script-security 2 -up /etc/transmission-daemon/start.sh -down /etc/transmission-daemon/stop.sh +up /etc/transmission/start.sh +down /etc/transmission/stop.sh diff --git a/openvpn/Israel.ovpn b/openvpn/pia/Israel.ovpn similarity index 60% rename from openvpn/Israel.ovpn rename to openvpn/pia/Israel.ovpn index 7a617e3..8d5dee1 100644 --- a/openvpn/Israel.ovpn +++ b/openvpn/pia/Israel.ovpn @@ -12,11 +12,11 @@ comp-lzo verb 1 reneg-sec 0 -ca /etc/openvpn/ca.crt -auth-user-pass /config/pia-credentials.txt -crl-verify /etc/openvpn/crl.pem +ca /etc/openvpn/pia/ca.crt +auth-user-pass /config/openvpn-credentials.txt +crl-verify /etc/openvpn/pia/crl.pem # OpenVPN control startup and shut down of transmission script-security 2 -up /etc/transmission-daemon/start.sh -down /etc/transmission-daemon/stop.sh +up /etc/transmission/start.sh +down /etc/transmission/stop.sh diff --git a/openvpn/Japan.ovpn b/openvpn/pia/Japan.ovpn similarity index 60% rename from openvpn/Japan.ovpn rename to openvpn/pia/Japan.ovpn index e3a8c1b..861c1ef 100644 --- a/openvpn/Japan.ovpn +++ b/openvpn/pia/Japan.ovpn @@ -12,11 +12,11 @@ comp-lzo verb 1 reneg-sec 0 -ca /etc/openvpn/ca.crt -auth-user-pass /config/pia-credentials.txt -crl-verify /etc/openvpn/crl.pem +ca /etc/openvpn/pia/ca.crt +auth-user-pass /config/openvpn-credentials.txt +crl-verify /etc/openvpn/pia/crl.pem # OpenVPN control startup and shut down of transmission script-security 2 -up /etc/transmission-daemon/start.sh -down /etc/transmission-daemon/stop.sh +up /etc/transmission/start.sh +down /etc/transmission/stop.sh diff --git a/openvpn/Mexico.ovpn b/openvpn/pia/Mexico.ovpn similarity index 60% rename from openvpn/Mexico.ovpn rename to openvpn/pia/Mexico.ovpn index e2498dd..562d7ef 100644 --- a/openvpn/Mexico.ovpn +++ b/openvpn/pia/Mexico.ovpn @@ -12,11 +12,11 @@ comp-lzo verb 1 reneg-sec 0 -ca /etc/openvpn/ca.crt -auth-user-pass /config/pia-credentials.txt -crl-verify /etc/openvpn/crl.pem +ca /etc/openvpn/pia/ca.crt +auth-user-pass /config/openvpn-credentials.txt +crl-verify /etc/openvpn/pia/crl.pem # OpenVPN control startup and shut down of transmission script-security 2 -up /etc/transmission-daemon/start.sh -down /etc/transmission-daemon/stop.sh +up /etc/transmission/start.sh +down /etc/transmission/stop.sh diff --git a/openvpn/Netherlands.ovpn b/openvpn/pia/Netherlands.ovpn similarity index 59% rename from openvpn/Netherlands.ovpn rename to openvpn/pia/Netherlands.ovpn index 4875fca..69921c3 100644 --- a/openvpn/Netherlands.ovpn +++ b/openvpn/pia/Netherlands.ovpn @@ -12,11 +12,11 @@ comp-lzo verb 1 reneg-sec 0 -ca /etc/openvpn/ca.crt -auth-user-pass /config/pia-credentials.txt -crl-verify /etc/openvpn/crl.pem +ca /etc/openvpn/pia/ca.crt +auth-user-pass /config/openvpn-credentials.txt +crl-verify /etc/openvpn/pia/crl.pem # OpenVPN control startup and shut down of transmission script-security 2 -up /etc/transmission-daemon/start.sh -down /etc/transmission-daemon/stop.sh +up /etc/transmission/start.sh +down /etc/transmission/stop.sh diff --git a/openvpn/Romania.ovpn b/openvpn/pia/Romania.ovpn similarity index 59% rename from openvpn/Romania.ovpn rename to openvpn/pia/Romania.ovpn index 5da65fd..ba2ed65 100644 --- a/openvpn/Romania.ovpn +++ b/openvpn/pia/Romania.ovpn @@ -12,11 +12,11 @@ comp-lzo verb 1 reneg-sec 0 -ca /etc/openvpn/ca.crt -auth-user-pass /config/pia-credentials.txt -crl-verify /etc/openvpn/crl.pem +ca /etc/openvpn/pia/ca.crt +auth-user-pass /config/openvpn-credentials.txt +crl-verify /etc/openvpn/pia/crl.pem # OpenVPN control startup and shut down of transmission script-security 2 -up /etc/transmission-daemon/start.sh -down /etc/transmission-daemon/stop.sh +up /etc/transmission/start.sh +down /etc/transmission/stop.sh diff --git a/openvpn/Russia.ovpn b/openvpn/pia/Russia.ovpn similarity index 60% rename from openvpn/Russia.ovpn rename to openvpn/pia/Russia.ovpn index 106f565..844412c 100644 --- a/openvpn/Russia.ovpn +++ b/openvpn/pia/Russia.ovpn @@ -12,11 +12,11 @@ comp-lzo verb 1 reneg-sec 0 -ca /etc/openvpn/ca.crt -auth-user-pass /config/pia-credentials.txt -crl-verify /etc/openvpn/crl.pem +ca /etc/openvpn/pia/ca.crt +auth-user-pass /config/openvpn-credentials.txt +crl-verify /etc/openvpn/pia/crl.pem # OpenVPN control startup and shut down of transmission script-security 2 -up /etc/transmission-daemon/start.sh -down /etc/transmission-daemon/stop.sh +up /etc/transmission/start.sh +down /etc/transmission/stop.sh diff --git a/openvpn/Singapore.ovpn b/openvpn/pia/Singapore.ovpn similarity index 59% rename from openvpn/Singapore.ovpn rename to openvpn/pia/Singapore.ovpn index 5cd195b..8ce8b3d 100644 --- a/openvpn/Singapore.ovpn +++ b/openvpn/pia/Singapore.ovpn @@ -12,11 +12,11 @@ comp-lzo verb 1 reneg-sec 0 -ca /etc/openvpn/ca.crt -auth-user-pass /config/pia-credentials.txt -crl-verify /etc/openvpn/crl.pem +ca /etc/openvpn/pia/ca.crt +auth-user-pass /config/openvpn-credentials.txt +crl-verify /etc/openvpn/pia/crl.pem # OpenVPN control startup and shut down of transmission script-security 2 -up /etc/transmission-daemon/start.sh -down /etc/transmission-daemon/stop.sh +up /etc/transmission/start.sh +down /etc/transmission/stop.sh diff --git a/openvpn/Sweden.ovpn b/openvpn/pia/Sweden.ovpn similarity index 60% rename from openvpn/Sweden.ovpn rename to openvpn/pia/Sweden.ovpn index 9129a59..2e191d6 100644 --- a/openvpn/Sweden.ovpn +++ b/openvpn/pia/Sweden.ovpn @@ -12,11 +12,11 @@ comp-lzo verb 1 reneg-sec 0 -ca /etc/openvpn/ca.crt -auth-user-pass /config/pia-credentials.txt -crl-verify /etc/openvpn/crl.pem +ca /etc/openvpn/pia/ca.crt +auth-user-pass /config/openvpn-credentials.txt +crl-verify /etc/openvpn/pia/crl.pem # OpenVPN control startup and shut down of transmission script-security 2 -up /etc/transmission-daemon/start.sh -down /etc/transmission-daemon/stop.sh +up /etc/transmission/start.sh +down /etc/transmission/stop.sh diff --git a/openvpn/Switzerland.ovpn b/openvpn/pia/Switzerland.ovpn similarity index 60% rename from openvpn/Switzerland.ovpn rename to openvpn/pia/Switzerland.ovpn index 8113f20..fd1f468 100644 --- a/openvpn/Switzerland.ovpn +++ b/openvpn/pia/Switzerland.ovpn @@ -12,11 +12,11 @@ comp-lzo verb 1 reneg-sec 0 -ca /etc/openvpn/ca.crt -auth-user-pass /config/pia-credentials.txt -crl-verify /etc/openvpn/crl.pem +ca /etc/openvpn/pia/ca.crt +auth-user-pass /config/openvpn-credentials.txt +crl-verify /etc/openvpn/pia/crl.pem # OpenVPN control startup and shut down of transmission script-security 2 -up /etc/transmission-daemon/start.sh -down /etc/transmission-daemon/stop.sh +up /etc/transmission/start.sh +down /etc/transmission/stop.sh diff --git a/openvpn/UK London.ovpn b/openvpn/pia/UK London.ovpn similarity index 60% rename from openvpn/UK London.ovpn rename to openvpn/pia/UK London.ovpn index 1c43b4d..c562eee 100644 --- a/openvpn/UK London.ovpn +++ b/openvpn/pia/UK London.ovpn @@ -12,11 +12,11 @@ comp-lzo verb 1 reneg-sec 0 -ca /etc/openvpn/ca.crt -auth-user-pass /config/pia-credentials.txt -crl-verify /etc/openvpn/crl.pem +ca /etc/openvpn/pia/ca.crt +auth-user-pass /config/openvpn-credentials.txt +crl-verify /etc/openvpn/pia/crl.pem # OpenVPN control startup and shut down of transmission script-security 2 -up /etc/transmission-daemon/start.sh -down /etc/transmission-daemon/stop.sh +up /etc/transmission/start.sh +down /etc/transmission/stop.sh diff --git a/openvpn/UK Southampton.ovpn b/openvpn/pia/UK Southampton.ovpn similarity index 60% rename from openvpn/UK Southampton.ovpn rename to openvpn/pia/UK Southampton.ovpn index a668641..3bc0d56 100644 --- a/openvpn/UK Southampton.ovpn +++ b/openvpn/pia/UK Southampton.ovpn @@ -12,11 +12,11 @@ comp-lzo verb 1 reneg-sec 0 -ca /etc/openvpn/ca.crt -auth-user-pass /config/pia-credentials.txt -crl-verify /etc/openvpn/crl.pem +ca /etc/openvpn/pia/ca.crt +auth-user-pass /config/openvpn-credentials.txt +crl-verify /etc/openvpn/pia/crl.pem # OpenVPN control startup and shut down of transmission script-security 2 -up /etc/transmission-daemon/start.sh -down /etc/transmission-daemon/stop.sh +up /etc/transmission/start.sh +down /etc/transmission/stop.sh diff --git a/openvpn/US California.ovpn b/openvpn/pia/US California.ovpn similarity index 60% rename from openvpn/US California.ovpn rename to openvpn/pia/US California.ovpn index 1b72cbb..5f4b83a 100644 --- a/openvpn/US California.ovpn +++ b/openvpn/pia/US California.ovpn @@ -12,11 +12,11 @@ comp-lzo verb 1 reneg-sec 0 -ca /etc/openvpn/ca.crt -auth-user-pass /config/pia-credentials.txt -crl-verify /etc/openvpn/crl.pem +ca /etc/openvpn/pia/ca.crt +auth-user-pass /config/openvpn-credentials.txt +crl-verify /etc/openvpn/pia/crl.pem # OpenVPN control startup and shut down of transmission script-security 2 -up /etc/transmission-daemon/start.sh -down /etc/transmission-daemon/stop.sh +up /etc/transmission/start.sh +down /etc/transmission/stop.sh diff --git a/openvpn/US East.ovpn b/openvpn/pia/US East.ovpn similarity index 60% rename from openvpn/US East.ovpn rename to openvpn/pia/US East.ovpn index 368eacd..dc001c7 100644 --- a/openvpn/US East.ovpn +++ b/openvpn/pia/US East.ovpn @@ -12,11 +12,11 @@ comp-lzo verb 1 reneg-sec 0 -ca /etc/openvpn/ca.crt -auth-user-pass /config/pia-credentials.txt -crl-verify /etc/openvpn/crl.pem +ca /etc/openvpn/pia/ca.crt +auth-user-pass /config/openvpn-credentials.txt +crl-verify /etc/openvpn/pia/crl.pem # OpenVPN control startup and shut down of transmission script-security 2 -up /etc/transmission-daemon/start.sh -down /etc/transmission-daemon/stop.sh +up /etc/transmission/start.sh +down /etc/transmission/stop.sh diff --git a/openvpn/US Florida.ovpn b/openvpn/pia/US Florida.ovpn similarity index 60% rename from openvpn/US Florida.ovpn rename to openvpn/pia/US Florida.ovpn index 2af9e4e..c0ad5ae 100644 --- a/openvpn/US Florida.ovpn +++ b/openvpn/pia/US Florida.ovpn @@ -12,11 +12,11 @@ comp-lzo verb 1 reneg-sec 0 -ca /etc/openvpn/ca.crt -auth-user-pass /config/pia-credentials.txt -crl-verify /etc/openvpn/crl.pem +ca /etc/openvpn/pia/ca.crt +auth-user-pass /config/openvpn-credentials.txt +crl-verify /etc/openvpn/pia/crl.pem # OpenVPN control startup and shut down of transmission script-security 2 -up /etc/transmission-daemon/start.sh -down /etc/transmission-daemon/stop.sh +up /etc/transmission/start.sh +down /etc/transmission/stop.sh diff --git a/openvpn/US Midwest.ovpn b/openvpn/pia/US Midwest.ovpn similarity index 60% rename from openvpn/US Midwest.ovpn rename to openvpn/pia/US Midwest.ovpn index 446357f..e6759c9 100644 --- a/openvpn/US Midwest.ovpn +++ b/openvpn/pia/US Midwest.ovpn @@ -12,11 +12,11 @@ comp-lzo verb 1 reneg-sec 0 -ca /etc/openvpn/ca.crt -auth-user-pass /config/pia-credentials.txt -crl-verify /etc/openvpn/crl.pem +ca /etc/openvpn/pia/ca.crt +auth-user-pass /config/openvpn-credentials.txt +crl-verify /etc/openvpn/pia/crl.pem # OpenVPN control startup and shut down of transmission script-security 2 -up /etc/transmission-daemon/start.sh -down /etc/transmission-daemon/stop.sh +up /etc/transmission/start.sh +down /etc/transmission/stop.sh diff --git a/openvpn/US Seattle.ovpn b/openvpn/pia/US Seattle.ovpn similarity index 60% rename from openvpn/US Seattle.ovpn rename to openvpn/pia/US Seattle.ovpn index c428b8e..b8dc7fb 100644 --- a/openvpn/US Seattle.ovpn +++ b/openvpn/pia/US Seattle.ovpn @@ -12,11 +12,11 @@ comp-lzo verb 1 reneg-sec 0 -ca /etc/openvpn/ca.crt -auth-user-pass /config/pia-credentials.txt -crl-verify /etc/openvpn/crl.pem +ca /etc/openvpn/pia/ca.crt +auth-user-pass /config/openvpn-credentials.txt +crl-verify /etc/openvpn/pia/crl.pem # OpenVPN control startup and shut down of transmission script-security 2 -up /etc/transmission-daemon/start.sh -down /etc/transmission-daemon/stop.sh +up /etc/transmission/start.sh +down /etc/transmission/stop.sh diff --git a/openvpn/US Silicon Valley.ovpn b/openvpn/pia/US Silicon Valley.ovpn similarity index 61% rename from openvpn/US Silicon Valley.ovpn rename to openvpn/pia/US Silicon Valley.ovpn index 71fdb84..108b654 100644 --- a/openvpn/US Silicon Valley.ovpn +++ b/openvpn/pia/US Silicon Valley.ovpn @@ -12,11 +12,11 @@ comp-lzo verb 1 reneg-sec 0 -ca /etc/openvpn/ca.crt -auth-user-pass /config/pia-credentials.txt -crl-verify /etc/openvpn/crl.pem +ca /etc/openvpn/pia/ca.crt +auth-user-pass /config/openvpn-credentials.txt +crl-verify /etc/openvpn/pia/crl.pem # OpenVPN control startup and shut down of transmission script-security 2 -up /etc/transmission-daemon/start.sh -down /etc/transmission-daemon/stop.sh +up /etc/transmission/start.sh +down /etc/transmission/stop.sh diff --git a/openvpn/US Texas.ovpn b/openvpn/pia/US Texas.ovpn similarity index 60% rename from openvpn/US Texas.ovpn rename to openvpn/pia/US Texas.ovpn index 470cb08..7a871ae 100644 --- a/openvpn/US Texas.ovpn +++ b/openvpn/pia/US Texas.ovpn @@ -12,11 +12,11 @@ comp-lzo verb 1 reneg-sec 0 -ca /etc/openvpn/ca.crt -auth-user-pass /config/pia-credentials.txt -crl-verify /etc/openvpn/crl.pem +ca /etc/openvpn/pia/ca.crt +auth-user-pass /config/openvpn-credentials.txt +crl-verify /etc/openvpn/pia/crl.pem # OpenVPN control startup and shut down of transmission script-security 2 -up /etc/transmission-daemon/start.sh -down /etc/transmission-daemon/stop.sh +up /etc/transmission/start.sh +down /etc/transmission/stop.sh diff --git a/openvpn/US West.ovpn b/openvpn/pia/US West.ovpn similarity index 60% rename from openvpn/US West.ovpn rename to openvpn/pia/US West.ovpn index a674271..b5cf04d 100644 --- a/openvpn/US West.ovpn +++ b/openvpn/pia/US West.ovpn @@ -12,11 +12,11 @@ comp-lzo verb 1 reneg-sec 0 -ca /etc/openvpn/ca.crt -auth-user-pass /config/pia-credentials.txt -crl-verify /etc/openvpn/crl.pem +ca /etc/openvpn/pia/ca.crt +auth-user-pass /config/openvpn-credentials.txt +crl-verify /etc/openvpn/pia/crl.pem # OpenVPN control startup and shut down of transmission script-security 2 -up /etc/transmission-daemon/start.sh -down /etc/transmission-daemon/stop.sh +up /etc/transmission/start.sh +down /etc/transmission/stop.sh diff --git a/openvpn/ca.crt b/openvpn/pia/ca.crt similarity index 100% rename from openvpn/ca.crt rename to openvpn/pia/ca.crt diff --git a/openvpn/crl.pem b/openvpn/pia/crl.pem similarity index 100% rename from openvpn/crl.pem rename to openvpn/pia/crl.pem diff --git a/openvpn/pia/default.ovpn b/openvpn/pia/default.ovpn new file mode 120000 index 0000000..d190674 --- /dev/null +++ b/openvpn/pia/default.ovpn @@ -0,0 +1 @@ +Netherlands.ovpn \ No newline at end of file diff --git a/openvpn/start.sh b/openvpn/start.sh index 211c1b3..36bde8c 100755 --- a/openvpn/start.sh +++ b/openvpn/start.sh @@ -1,19 +1,28 @@ #!/bin/sh -if [ ! -z "$OPEN_VPN_CONFIG" ] +if [ "$OPENVPN_PROVIDER" = "BTGUARD" ] then - if [ -f /etc/openvpn/"${OPEN_VPN_CONFIG}".ovpn ] + echo "VPN PROVIDER: BTGUARD" + vpn_provider="btguard" +else + echo "VPN PROVIDER: PIA" + vpn_provider="pia" +fi + +if [ ! -z "$OPENVPN_CONFIG" ] +then + if [ -f /etc/openvpn/$vpn_provider/"${OPENVPN_CONFIG}".ovpn ] then - echo "Starting OpenVPN using config ${OPEN_VPN_CONFIG}.ovpn" - OPEN_VPN_CONFIG=/etc/openvpn/${OPEN_VPN_CONFIG}.ovpn + echo "Starting OpenVPN using config ${OPENVPN_CONFIG}.ovpn" + OPENVPN_CONFIG=/etc/openvpn/$vpn_provider/${OPENVPN_CONFIG}.ovpn else - echo "Supplied config ${OPEN_VPN_CONFIG}.ovpn could not be found." - echo "Using default OpenVPN gateway: Netherlands" - OPEN_VPN_CONFIG=/etc/openvpn/Netherlands.ovpn + echo "Supplied config ${OPENVPN_CONFIG}.ovpn could not be found." + echo "Using default OpenVPN gateway for provider ${vpn_provider}" + OPENVPN_CONFIG=/etc/openvpn/$vpn_provider/default.ovpn fi else - echo "No VPN configuration provided. Using default: Netherlands" - OPEN_VPN_CONFIG=/etc/openvpn/Netherlands.ovpn + echo "No VPN configuration provided. Using default." + OPENVPN_CONFIG=/etc/openvpn/$vpn_provider/default.ovpn fi # override resolv.conf @@ -23,15 +32,15 @@ then printf "$RESOLV_OVERRIDE" > /etc/resolv.conf fi -# add PIA user/pass -if [ "${PIA_USERNAME}" = "**None**" ] || [ "${PIA_PASSWORD}" = "**None**" ] ; then +# add OpenVPN user/pass +if [ "${OPENVPN_USERNAME}" = "**None**" ] || [ "${OPENVPN_PASSWORD}" = "**None**" ] ; then echo "PIA credentials not set. Exiting." exit 1 else - echo "Setting PIA credentials..." + echo "Setting OPENVPN credentials..." mkdir -p /config - echo $PIA_USERNAME > /config/pia-credentials.txt - echo $PIA_PASSWORD >> /config/pia-credentials.txt + echo $OPENVPN_USERNAME > /config/openvpn-credentials.txt + echo $OPENVPN_PASSWORD >> /config/openvpn-credentials.txt fi # add transmission credentials from env vars @@ -39,6 +48,6 @@ echo $TRANSMISSION_RPC_USERNAME > /config/transmission-credentials.txt echo $TRANSMISSION_RPC_PASSWORD >> /config/transmission-credentials.txt # Persist transmission settings for use by transmission-daemon -dockerize -template /etc/transmission-daemon/environment-variables.tmpl:/etc/transmission-daemon/environment-variables.sh /bin/true +dockerize -template /etc/transmission/environment-variables.tmpl:/etc/transmission/environment-variables.sh /bin/true -exec openvpn --config "$OPEN_VPN_CONFIG" +exec openvpn --config "$OPENVPN_CONFIG" diff --git a/transmission/environment-variables.tmpl b/transmission/environment-variables.tmpl index 47c0421..510727a 100644 --- a/transmission/environment-variables.tmpl +++ b/transmission/environment-variables.tmpl @@ -72,3 +72,5 @@ export TRANSMISSION_UTP_ENABLED={{ .Env.TRANSMISSION_UTP_ENABLED }} export TRANSMISSION_WATCH_DIR={{ .Env.TRANSMISSION_WATCH_DIR }} export TRANSMISSION_WATCH_DIR_ENABLED={{ .Env.TRANSMISSION_WATCH_DIR_ENABLED }} +# Transmission needs to know which VPN provider is used +export OPENVPN_PROVIDER={{ .Env.OPENVPN_PROVIDER }} \ No newline at end of file diff --git a/transmission/periodicUpdates.sh b/transmission/periodicUpdates.sh index 2325b27..3bc3fe9 100755 --- a/transmission/periodicUpdates.sh +++ b/transmission/periodicUpdates.sh @@ -3,6 +3,6 @@ while [ 1 ] do sleep 1m - /etc/transmission-daemon/updatePort.sh + /etc/transmission/updatePort.sh sleep 1h done diff --git a/transmission/start.sh b/transmission/start.sh index 0b5f580..60015af 100755 --- a/transmission/start.sh +++ b/transmission/start.sh @@ -1,7 +1,7 @@ #!/bin/sh # Source our persisted env variables from container startup -. /etc/transmission-daemon/environment-variables.sh +. /etc/transmission/environment-variables.sh tun0ip=$(ifconfig tun0 | sed -n '2 p' | awk '{print $2}' | cut -d: -f2) echo "Updating TRANSMISSION_BIND_ADDRESS_IPV4 to tun0 ip: ${tun0ip}" @@ -10,12 +10,17 @@ export TRANSMISSION_BIND_ADDRESS_IPV4=${tun0ip} echo "Generating transmission settings.json from env variables" # Ensure TRANSMISSION_HOME is created mkdir -p ${TRANSMISSION_HOME} -dockerize -template /etc/transmission-daemon/settings.tmpl:${TRANSMISSION_HOME}/settings.json /bin/true +dockerize -template /etc/transmission/settings.tmpl:${TRANSMISSION_HOME}/settings.json /bin/true echo "STARTING TRANSMISSION" exec /usr/bin/transmission-daemon -g ${TRANSMISSION_HOME} & -echo "STARTING PORT UPDATER" -exec /etc/transmission-daemon/periodicUpdates.sh & +if [ "$OPENVPN_PROVIDER" = "PIA" ] +then + echo "STARTING PORT UPDATER" + exec /etc/transmission/periodicUpdates.sh & +else + echo "NO PORT UPDATER FOR THIS PROVIDER" +fi echo "Transmission startup script complete." diff --git a/transmission/updatePort.sh b/transmission/updatePort.sh index 3afe85e..3c3f276 100755 --- a/transmission/updatePort.sh +++ b/transmission/updatePort.sh @@ -1,10 +1,10 @@ #! /bin/sh # Source our persisted env variables from container startup -. /etc/transmission-daemon/environment-variables.sh +. /etc/transmission/environment-variables.sh # Settings -PIA_PASSWD_FILE=/config/pia-credentials.txt +PIA_PASSWD_FILE=/config/openvpn-credentials.txt TRANSMISSION_PASSWD_FILE=/config/transmission-credentials.txt pia_username=$(head -1 $PIA_PASSWD_FILE) @@ -12,7 +12,7 @@ pia_passwd=$(tail -1 $PIA_PASSWD_FILE) transmission_username=$(head -1 $TRANSMISSION_PASSWD_FILE) transmission_passwd=$(tail -1 $TRANSMISSION_PASSWD_FILE) local_vpn_ip=$(ip addr show tun0 | grep inet | awk '{ print $2 }') -pia_client_id_file=/etc/transmission-daemon/pia_client_id +pia_client_id_file=/etc/transmission/pia_client_id transmission_settings_file=${TRANSMISSION_HOME}/settings.json port_assignment_url=https://www.privateinternetaccess.com/vpninfo/port_forward_assignment