Giter Site home page Giter Site logo

chiggins / docker-transmission-openvpn Goto Github PK

View Code? Open in Web Editor NEW

This project forked from haugene/docker-transmission-openvpn

0.0 1.0 0.0 49.37 MB

Docker container running Transmission torrent client with WebUI over an OpenVPN tunnel

License: GNU General Public License v3.0

Shell 85.03% Dockerfile 6.16% Python 8.81%

docker-transmission-openvpn's Introduction

OpenVPN and Transmission with WebUI

CircleCI builds Docker Pulls Join the chat at https://gitter.im/docker-transmission-openvpn/Lobby

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. If you can't find your answer in the docs, please search for similar issues (open and closed) before opening a new one.

Still can't figure it out? Open a new issue and share the details of your setup and some logs. Without that it's hard to help you. If you have a proposal for better documentation, come with it. PR's are always welcome! :)

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!

docker-transmission-openvpn's People

Contributors

aaronblair avatar aerickson avatar borysekondrej avatar bperel avatar clement-z avatar dan1el avatar dulanic avatar e7d avatar echaupynx avatar eskemojoe007 avatar g-be avatar gpongelli avatar haugene avatar himred avatar ilike2burnthing avatar jandrews377 avatar jfessard avatar jsloan117 avatar koenvanderlinden avatar ksurl avatar menteb avatar nightbr avatar othou avatar pkishino avatar printgeek avatar qoobaa avatar rsalas avatar shuaiscott avatar troubadoure avatar wilmardo avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.