Go to file
Patrick Kishino 2affaf7cd0
Added support for Shift UI (#1926)
* Added support for Shift UI

* docs added
2021-09-04 12:25:27 +09:00
.circleci Update buildx and oneliner context create 2021-03-31 09:39:44 +02:00
.github Update PULL_REQUEST_TEMPLATE.md 2021-04-13 13:49:58 +09:00
docs Added support for Shift UI (#1926) 2021-09-04 12:25:27 +09:00
images Improving documentation, not done but getting somewhere #1558 2020-11-26 22:53:37 +01:00
openvpn ca replace corrected to include the ca cert 2021-08-25 08:43:55 +09:00
plugins/rss RSS plugin not supporting HTTP authorization (#1741) 2021-03-27 06:22:14 +09:00
privoxy/scripts Restore Privoxy functionality 2021-03-30 00:42:19 +02:00
proxy Added simple example to nginx for further services (#1766) 2021-03-16 08:33:33 +09:00
scripts Initial version of route-pre-down script (#1502) 2021-04-29 09:24:52 +09:00
transmission Added support for Shift UI (#1926) 2021-09-04 12:25:27 +09:00
.dockerignore * Add .git to .dockerignore so we don't send to docker build context 2018-02-15 16:05:04 +00:00
docker-compose.yml Merge branch 'dev' into master 2018-01-02 08:46:33 +13:00
Dockerfile Added support for Shift UI (#1926) 2021-09-04 12:25:27 +09:00
LICENSE initial commit. working, but needs more features 2014-11-09 16:23:18 +01:00
mkdocs.yml Update documentation, add debugging guide #1558 2020-12-05 02:18:16 +01:00
README.md Prepare move from Gitter to GitHub Discussions 2021-03-31 01:52:50 +02:00

OpenVPN and Transmission with WebUI

CircleCI builds Docker Pulls

This container contains OpenVPN and Transmission with a configuration where Transmission is running only when OpenVPN has an active tunnel. It has built in support for many popular VPN providers to make the setup easier.

Before you continue

The documentation for this image is here:

https://haugene.github.io/docker-transmission-openvpn/

Start there if you're having issues or questions about your container. Another great source of information is to search for similar issues.

We're also in the process of setting up GitHub Discussions for general help and Q&A sections. If you've tried everything else you can create an issue, but we might convert it to a discussion if it does not relate to an actual problem or feature request with the container itself.

Release 4.0: We've recently released version 4.0 which brings the following major changes:

  • Image is based on Ubuntu instead of Alpine
  • OpenVPN config files are moved to a separate repository
  • Replaced Tinyproxy with Privoxy for our web proxy

If you're experiencing issues with the new major version please open an issue for it. As a temporary workaround you can have a look at our releases and downgrade to one of the 3.x versions instead.

Quick Start

These examples shows valid setups using PIA as provider for both docker run and docker-compose. Note that you should read some documentation at some point, but this is a good place to start.

Docker run

$ docker run --cap-add=NET_ADMIN -d \
              -v /your/storage/path/:/data \
              -e OPENVPN_PROVIDER=PIA \
              -e OPENVPN_CONFIG=france \
              -e OPENVPN_USERNAME=user \
              -e OPENVPN_PASSWORD=pass \
              -e LOCAL_NETWORK=192.168.0.0/16 \
              --log-driver json-file \
              --log-opt max-size=10m \
              -p 9091:9091 \
              haugene/transmission-openvpn

Docker Compose

version: '3.3'
services:
    transmission-openvpn:
        cap_add:
            - NET_ADMIN
        volumes:
            - '/your/storage/path/:/data'
        environment:
            - OPENVPN_PROVIDER=PIA
            - OPENVPN_CONFIG=france
            - OPENVPN_USERNAME=user
            - OPENVPN_PASSWORD=pass
            - LOCAL_NETWORK=192.168.0.0/16
        logging:
            driver: json-file
            options:
                max-size: 10m
        ports:
            - '9091:9091'
        image: haugene/transmission-openvpn

Please help out (about:maintenance)

This image was created for my own use, but sharing is caring, so it had to be open source. It has now gotten quite popular, and that's great! But keeping it up to date, providing support, fixes and new features takes time. If you feel that you're getting a good tool and want to support it, there are a couple of options:

A small montly amount through Donate with Patreon or a one time donation with Donate with PayPal

All donations are greatly appreciated! Another great way to contribute is of course through code. A big thanks to everyone who has contributed so far!