From 29618ffbcbd614f9c2a84c0d4e5edc20654e4a7b Mon Sep 17 00:00:00 2001 From: Kristian Haugene Date: Sat, 9 May 2015 19:22:07 +0200 Subject: [PATCH] Update README.md --- README.md | 21 +++++++++++++++++++-- 1 file changed, 19 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 805b39f..fb844e2 100644 --- a/README.md +++ b/README.md @@ -6,7 +6,20 @@ This Docker container lets you run Transmission with WebUI while connecting to P 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 -v /your/storage/path/:/data -v /your/config/path/:/config -p 9091:9091 haugene/transmission-openvpn +$ docker run --privileged -d \ + -v /your/storage/path/:/data \ + -v /your/config/path/:/config \ + -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. +``` +$ docker run --privileged -d \ + -v /your/storage/path/:/data \ + -v /your/config/path/:/config \ + -p 9091:9091 \ + -e "OPEN_VPN_CONFIG=US West" \ + haugene/transmission-openvpn ``` As you can see, the container expects two volumes to be mounted. One is used for storing your downloads from Transmission, and the other provides configurations. 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. @@ -25,7 +38,11 @@ $ docker build -t="docker-transmission-openvpn" . ``` ### Run it: ``` -$ docker run --privileged -d -v /your/storage/path/:/data -v /your/config/path/:/config -p 9091:9091 docker-transmission-openvpn +$ docker run --privileged -d \ + -v /your/storage/path/:/data \ + -v /your/config/path/:/config \ + -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.