Kristian Haugene
8 jaren geleden
1 gewijzigde bestanden met toevoegingen van 51 en 45 verwijderingen
+ 51
- 45
README.md
Bestand weergeven
| @@ -110,12 +110,18 @@ 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. Alternatively if you use container linking, either directly or via docker-compose, you can replace "your.host.ip.addr" with the name or alias of the openvpn container. | |||
| ## Known issues | |||
| ## Known issues, tips and tricks | |||
| #### Use Google DNS servers | |||
| 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. | |||
| #### Restart container if connection is lost | |||
| If the VPN connection fails or the container for any other reason loses connectivity, you want it to recover from it. One way of doing this is to set environment variable `OPENVPN_OPTS=--inactive 3600 --ping 10 --ping-exit 60` and use the --restart=always flag when starting the container. This way OpenVPN will exit if ping fails over a period of time which will stop the container and then the Docker deamon will restart it. | |||
| #### Questions? | |||
| 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. | |||
| @@ -123,9 +129,9 @@ Using the latest stable verison of Docker is always recommended. Support for old | |||
| ## Adding new providers | |||
| If your VPN provider is not in the list of supported providers you could always create an issue on GitHub and see if someone could add it for you. But if you're feeling up for doing it yourself, here's a couple of pointers. | |||
| You clone this repository and create a new folder under "openvpn" where you put the .ovpn files your provider gives you. Depending on the structure of these files you need to make some adjustments. For example if they come with a ca.crt file that is referenced in the config you need to update this reference to the path it will have inside the container (which is /etc/openvpn/...). You also have to set where to look for your username/password and what to do when a connection is created (namely starting Transmission). In [this commit](https://github.com/haugene/docker-transmission-openvpn/commit/f10b134c2ebc76dfa97ebdeea7ec285ad7d4f9b4) you can see the changes done when adding IPVanish as provider. In general, it's all been done before so look around the commits and you should find what you're looking for. | |||
| You clone this repository and create a new folder under "openvpn" where you put the .ovpn files your provider gives you. Depending on the structure of these files you need to make some adjustments. For example if they come with a ca.crt file that is referenced in the config you need to update this reference to the path it will have inside the container (which is /etc/openvpn/...). You also have to set where to look for your username/password. | |||
| There is also a script called adjustConfigs.sh that could help you. After putting your .ovpn files in a folder, run that script with your folder name as parameter and it will try to do the changes descibed above. If you use it or not, reading it might give you some help in what you're looking to change in the .ovpn files. | |||
| There is a script called adjustConfigs.sh that could help you. After putting your .ovpn files in a folder, run that script with your folder name as parameter and it will try to do the changes descibed above. If you use it or not, reading it might give you some help in what you're looking to change in the .ovpn files. | |||
| Once you've finished modifying configs, you build the container and run it with OPENVPN_PROVIDER set to the name of the folder of configs you just created (it will be lowercased to match the folder names). And that should be it! | |||
| @@ -140,7 +146,7 @@ Add a new volume mount to your `docker run` command that mounts your config file | |||
| Then you can set `OPENVPN_PROVIDER=CUSTOM`and the container will use the config you provided. If you are using AirVPN or other provider with credentials in the config file, you still need to set `OPENVPN_USERNAME` and `OPENVPN_PASSWORD` as this is required by the startup script. They will not be read by the .ovpn file, so you can set them to whatever. | |||
| Note that you still need to modify your .ovpn file to include the up/down statements for Transmission etc, described in the previous section. If you have an separate ca.crt file your volume mount should be a folder containing both the ca.crt and the .ovpn config. | |||
| Note that you still need to modify your .ovpn file as described in the previous section. If you have an separate ca.crt file your volume mount should be a folder containing both the ca.crt and the .ovpn config. | |||
| ## Building the container yourself | |||
| To build this container, clone the repository and cd into it. | |||
| @@ -170,6 +176,47 @@ If you have transmission authentication enabled and want scripts in another cont | |||
| 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. | |||
| ## Make it work on Synology NAS | |||
| Here are the steps to run it on a Synology NAS (Tested on DSM 6) : | |||
| - Connect as _admin_ to your Synology SSH | |||
| - Switch to root with command `sudo su -` | |||
| - Enter your _admin_ password when prompted | |||
| - Create a TUN.sh file anywhere in your synology file system by typing `vim /volume1/foldername/TUN.sh` | |||
| replacing _foldername_ with any folder you created on your Synology | |||
| - Paste @timkelty 's script : | |||
| ``` | |||
| #!/bin/sh | |||
| # Create the necessary file structure for /dev/net/tun | |||
| if ( [ ! -c /dev/net/tun ] ); then | |||
| if ( [ ! -d /dev/net ] ); then | |||
| mkdir -m 755 /dev/net | |||
| fi | |||
| mknod /dev/net/tun c 10 200 | |||
| fi | |||
| # Load the tun module if not already loaded | |||
| if ( !(lsmod | grep -q "^tun\s") ); then | |||
| insmod /lib/modules/tun.ko | |||
| fi | |||
| ``` | |||
| - Save the file with [escape] + `:wq!` | |||
| - Go in the folder containing your script : `cd /volume1/foldername/` | |||
| - Check permission with `chmod 0755 TUN.sh` | |||
| - Run it with `./TUN.sh` | |||
| - Return to initial directory typing `cd` | |||
| - Create the DNS config file by typing `vim /volume1/foldername/resolv.conf` | |||
| - Paste the following lines : | |||
| ``` | |||
| nameserver 8.8.8.8 | |||
| nameserver 8.8.4.4 | |||
| ``` | |||
| - Save the file with [escape] + `:wq!` | |||
| - Create your docker container with a classic command like `docker run --privileged -d -v /volume1/foldername/resolv.conf:/etc/resolv.conf -v /volume1/yourpath/:/data -e "OPENVPN_PROVIDER=PIA" -e "OPENVPN_CONFIG=Netherlands" -e "OPENVPN_USERNAME=XXXXX" -e "OPENVPN_PASSWORD=XXXXX" -p 9091:9091 haugene/transmission-openvpn -name TransmissionVPN` | |||
| - To make it work after a nas restart, create an automated task in your synology web interface : go to **Settings Panel > Task Scheduler ** create a new task that run `/volume1/foldername/TUN.sh` as root (select '_root_' in 'user' selectbox). This task will start module that permit the container to run, you can make a task that run on startup. These kind of task doesn't work on my nas so I just made a task that run every minute. | |||
| - Enjoy | |||
| ## systemd Integration | |||
| On many modern linux systems, including Ubuntu, systemd can be used to start the transmission-openvpn at boot time, and restart it after any failure. | |||
| @@ -227,44 +274,3 @@ $ sudo systemctl stop transmission-openvpn.service | |||
| # Later ... | |||
| $ sudo systemctl start transmission-openvpn.service | |||
| ``` | |||
| ## Make it work on Synology NAS | |||
| Here are the steps to run it on a Synology NAS (Tested on DSM 6) : | |||
| - Connect as _admin_ to your Synology SSH | |||
| - Switch to root with command `sudo su -` | |||
| - Enter your _admin_ password when prompted | |||
| - Create a TUN.sh file anywhere in your synology file system by typing `vim /volume1/foldername/TUN.sh` | |||
| replacing _foldername_ with any folder you created on your Synology | |||
| - Paste @timkelty 's script : | |||
| ``` | |||
| #!/bin/sh | |||
| # Create the necessary file structure for /dev/net/tun | |||
| if ( [ ! -c /dev/net/tun ] ); then | |||
| if ( [ ! -d /dev/net ] ); then | |||
| mkdir -m 755 /dev/net | |||
| fi | |||
| mknod /dev/net/tun c 10 200 | |||
| fi | |||
| # Load the tun module if not already loaded | |||
| if ( !(lsmod | grep -q "^tun\s") ); then | |||
| insmod /lib/modules/tun.ko | |||
| fi | |||
| ``` | |||
| - Save the file with [escape] + `:wq!` | |||
| - Go in the folder containing your script : `cd /volume1/foldername/` | |||
| - Check permission with `chmod 0755 TUN.sh` | |||
| - Run it with `./TUN.sh` | |||
| - Return to initial directory typing `cd` | |||
| - Create the DNS config file by typing `vim /volume1/foldername/resolv.conf` | |||
| - Paste the following lines : | |||
| ``` | |||
| nameserver 8.8.8.8 | |||
| nameserver 8.8.4.4 | |||
| ``` | |||
| - Save the file with [escape] + `:wq!` | |||
| - Create your docker container with a classic command like `docker run --privileged -d -v /volume1/foldername/resolv.conf:/etc/resolv.conf -v /volume1/yourpath/:/data -e "OPENVPN_PROVIDER=PIA" -e "OPENVPN_CONFIG=Netherlands" -e "OPENVPN_USERNAME=XXXXX" -e "OPENVPN_PASSWORD=XXXXX" -p 9091:9091 haugene/transmission-openvpn -name TransmissionVPN` | |||
| - To make it work after a nas restart, create an automated task in your synology web interface : go to **Settings Panel > Task Scheduler ** create a new task that run `/volume1/foldername/TUN.sh` as root (select '_root_' in 'user' selectbox). This task will start module that permit the container to run, you can make a task that run on startup. These kind of task doesn't work on my nas so I just made a task that run every minute. | |||
| - Enjoy | |||
Laden…