modified startup scripts to support more vpn providers

This commit is contained in:
Kristian Haugene 2015-08-07 23:07:55 +02:00
parent fa0a0d6e0e
commit 91ccd7e3dd
39 changed files with 165 additions and 104 deletions

View File

@ -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-daemon/
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" \

View File

@ -8,8 +8,8 @@ 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_USERNAME=user" \
-e "OPENVPN_PASSWORD=pass" \
-p 9091:9091 \
haugene/transmission-openvpn
```
@ -19,8 +19,8 @@ or you could optionally specify which vpn server to use by setting an environmen
```
$ docker run --privileged -d \
-v /your/storage/path/:/data \
-e "PIA_USERNAME=user" \
-e "PIA_PASSWORD=pass" \
-e "OPENVPN_USERNAME=user" \
-e "OPENVPN_PASSWORD=pass" \
-p 9091:9091 \
-e "OPEN_VPN_CONFIG=US West" \
haugene/transmission-openvpn
@ -28,13 +28,13 @@ $ docker run --privileged -d \
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.
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.
The only mandatory configuration is to set two environment variables for your PIA username and password. You must set the environment variables `OPENVPN_USERNAME` and `OPENVPN_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 login username for PIA|`OPENVPN_USERNAME=asdf`|
|`OPENVPN_PASSWORD`|Your login password for PIA|`OPENVPN_PASSWORD=asdf`|
### Network configuration options
| Variable | Function | Example |
@ -71,8 +71,8 @@ $ docker build -t="docker-transmission-openvpn" .
```
$ docker run --privileged -d \
-v /your/storage/path/:/data \
-e "PIA_USERNAME=user" \
-e "PIA_PASSWORD=pass" \
-e "OPENVPN_USERNAME=user" \
-e "OPENVPN_PASSWORD=pass" \
-p 9091:9091 \
docker-transmission-openvpn
```

0
docker-compose.yml Normal file
View File

View File

@ -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-----

View File

@ -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-daemon/start.sh
down /etc/transmission-daemon/stop.sh

View File

@ -0,0 +1 @@
btguard.ovpn

View File

@ -12,9 +12,9 @@ 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

View File

@ -12,9 +12,9 @@ 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

View File

@ -12,9 +12,9 @@ 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

View File

@ -12,9 +12,9 @@ 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

View File

@ -12,9 +12,9 @@ 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

View File

@ -12,9 +12,9 @@ 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

View File

@ -12,9 +12,9 @@ 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

View File

@ -12,9 +12,9 @@ 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

View File

@ -12,9 +12,9 @@ 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

View File

@ -12,9 +12,9 @@ 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

View File

@ -12,9 +12,9 @@ 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

View File

@ -12,9 +12,9 @@ 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

View File

@ -12,9 +12,9 @@ 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

View File

@ -12,9 +12,9 @@ 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

View File

@ -12,9 +12,9 @@ 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

View File

@ -12,9 +12,9 @@ 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

View File

@ -12,9 +12,9 @@ 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

View File

@ -12,9 +12,9 @@ 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

View File

@ -12,9 +12,9 @@ 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

View File

@ -12,9 +12,9 @@ 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

View File

@ -12,9 +12,9 @@ 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

View File

@ -12,9 +12,9 @@ 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

View File

@ -12,9 +12,9 @@ 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

View File

@ -12,9 +12,9 @@ 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

View File

@ -12,9 +12,9 @@ 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

View File

@ -12,9 +12,9 @@ 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

1
openvpn/pia/default.ovpn Symbolic link
View File

@ -0,0 +1 @@
Netherlands.ovpn

View File

@ -1,19 +1,28 @@
#!/bin/sh
if [ "$OPENVPN_PROVIDER" = "BTGUARD" ]
then
echo "VPN PROVIDER: BTGUARD"
vpn_provider="btguard"
else
echo "VPN PROVIDER: PIA"
vpn_provider="pia"
fi
if [ ! -z "$OPEN_VPN_CONFIG" ]
then
if [ -f /etc/openvpn/"${OPEN_VPN_CONFIG}".ovpn ]
if [ -f /etc/openvpn/$vpn_provider/"${OPEN_VPN_CONFIG}".ovpn ]
then
echo "Starting OpenVPN using config ${OPEN_VPN_CONFIG}.ovpn"
OPEN_VPN_CONFIG=/etc/openvpn/${OPEN_VPN_CONFIG}.ovpn
OPEN_VPN_CONFIG=/etc/openvpn/$vpn_provider/${OPEN_VPN_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 "Using default OpenVPN gateway for provider ${vpn_provider}"
OPEN_VPN_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."
OPEN_VPN_CONFIG=/etc/openvpn/$vpn_provider/default.ovpn
fi
# override resolv.conf
@ -24,14 +33,14 @@ then
fi
# add PIA user/pass
if [ "${PIA_USERNAME}" = "**None**" ] || [ "${PIA_PASSWORD}" = "**None**" ] ; then
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

View File

@ -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 }}

View File

@ -13,7 +13,12 @@ dockerize -template /etc/transmission-daemon/settings.tmpl:/etc/transmission-dae
echo "STARTING TRANSMISSION"
exec /usr/bin/transmission-daemon -g /etc/transmission-daemon/ &
echo "STARTING PORT UPDATER"
exec /etc/transmission-daemon/periodicUpdates.sh &
if [ "$OPENVPN_PROVIDER" = "PIA" ]
then
echo "STARTING PORT UPDATER"
exec /etc/transmission-daemon/periodicUpdates.sh &
else
echo "NO PORT UPDATER FOR THIS PROVIDER"
fi
echo "Transmission startup script complete."

View File

@ -1,7 +1,7 @@
#! /bin/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)