bea/docker-deluge-openvpn
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Update README for 3.0

Browse Source
This commit is contained in:
Kristian Haugene
2020-10-28 21:31:05 +01:00
parent 59bc02621e
commit e3fcafcd00
1 changed files with 19 additions and 40 deletions
Download Patch File Download Diff File Expand all files Collapse all files

59
README.md
View File

@@ -4,28 +4,24 @@
[![Docker Pulls](https://img.shields.io/docker/pulls/haugene/transmission-openvpn.svg)](https://hub.docker.com/r/haugene/transmission-openvpn/) [![Docker Pulls](https://img.shields.io/docker/pulls/haugene/transmission-openvpn.svg)](https://hub.docker.com/r/haugene/transmission-openvpn/)
[![Join the chat at https://gitter.im/docker-transmission-openvpn/Lobby](https://badges.gitter.im/docker-transmission-openvpn/Lobby.svg)](https://gitter.im/docker-transmission-openvpn/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![Join the chat at https://gitter.im/docker-transmission-openvpn/Lobby](https://badges.gitter.im/docker-transmission-openvpn/Lobby.svg)](https://gitter.im/docker-transmission-openvpn/Lobby?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
## Deprecation Warning - changes are coming! ## Version 3.0 released - we have some breaking changes (but not much)
**TL;DR:** Nothing has changed yet for the `latest` tag, but there is a 3.0 version coming. Until then the `dev` tag could be more unstable than before. Those of you who are following this project knows that we have had some larger changes coming for a while.
Hobby projects often get last in line for some love and care, and it took longer than I hoped but here we are.
After years of maintaining and developing this project there are a couple of things that users keep asking about and that Some highlights on version 3.0:
we now want to change in order to eventually make it easier for everyone.
It looks like we will be close to 100% backwards compatible but we will probably have a couple of breaking changes where users would have to rename a config parameter or two, etc.
As of now we are devoting the dev branch to development of the new version 3.0, and the master branch will continue on 2.x.
Updates to openvpn configs and other smaller changes should be contributed to the master branch as the dev branch will not be merged into master before we have developed, tested and stabilized the new version.
Some highlights on version 3.x:
* We're dropping the ubuntu based image and making alpine the default (reduce double maintenance) * We're dropping the ubuntu based image and making alpine the default (reduce double maintenance)
* We're making Transmission settings persistent by default, removing the need for all the environment variables (but keeping support for it) * We're making Transmission settings persistent by default, removing the need for all the environment variables (but keeping support for it)
* We're making it easier to provide your own OpenVPN (.ovpn) config file. * We're making it easier to provide your own OpenVPN (.ovpn) config file - adding scripts in the container to modify provider configs as needed to fit the container setup. (still in early stages at this point)
* Possibly extracting the OpenVPN configs so that we can maintain that in a separate project and focus on the core in this project. * We're adding a standardized way to add scripts for doing necessary setup of a provider. This usually means to download a .ovpn config bundle, unpack it and modify it correctly to work in this container.
These changes will not be in effect in a while yet, and I will update here when they are and provide a list of non backwards compatible changes. Hopefully these changes will improve the usability of this container. As maintainers we also hope that it will free up time to keep the container up to date and stable instead of managing thousands of .ovpn files coming and going.
If you are following the "latest" tag, at some point it will be changed to the 3.x version and your container might break. At that point, either follow the
upgrade guide (coming) or revert the version to the latest release on 2.x versions.
The dev branch will be used for the 3.x going forwards, so to all of you following that one. You have been warned, it might be a bit unstable going forwards. I'll try to keep a list of breaking changes here, and add to it if we come across more:
* The CREATE_TUN_DEVICE variable now defaults to true. Mounting /dev/net/tun will lead to an error message in the logs unless you explicitly set it to false.
* The DOCKER_LOG variable is renamed to LOG_TO_STDOUT
PS: Now more than ever. We appreciate that you report bugs and issues when you find them. But as there might be more than ususal, please make sure you search and look for a similar one before possibly creating a duplicate.
## Quick Start ## Quick Start
@@ -36,10 +32,8 @@ It bundles configuration files for many popular VPN providers to make the setup
``` ```
$ docker run --cap-add=NET_ADMIN -d \ $ docker run --cap-add=NET_ADMIN -d \
-v /your/storage/path/:/data \ -v /your/storage/path/:/data \
-v /etc/localtime:/etc/localtime:ro \
-e CREATE_TUN_DEVICE=true \
-e OPENVPN_PROVIDER=PIA \ -e OPENVPN_PROVIDER=PIA \
-e OPENVPN_CONFIG=CA\ Toronto \ -e OPENVPN_CONFIG=France \
-e OPENVPN_USERNAME=user \ -e OPENVPN_USERNAME=user \
-e OPENVPN_PASSWORD=pass \ -e OPENVPN_PASSWORD=pass \
-e WEBPROXY_ENABLED=false \ -e WEBPROXY_ENABLED=false \
@@ -57,11 +51,9 @@ services:
transmission-openvpn: transmission-openvpn:
volumes: volumes:
- '/your/storage/path/:/data' - '/your/storage/path/:/data'
- '/etc/localtime:/etc/localtime:ro'
environment: environment:
- CREATE_TUN_DEVICE=true
- OPENVPN_PROVIDER=PIA - OPENVPN_PROVIDER=PIA
- OPENVPN_CONFIG=CA Toronto - OPENVPN_CONFIG=France
- OPENVPN_USERNAME=user - OPENVPN_USERNAME=user
- OPENVPN_PASSWORD=pass - OPENVPN_PASSWORD=pass
- WEBPROXY_ENABLED=false - WEBPROXY_ENABLED=false
@@ -83,23 +75,10 @@ The full documentation is available at https://haugene.github.io/docker-transmis
## Please help out (about:maintenance) ## Please help out (about:maintenance)
This image was created for my own use, but sharing is caring, so it had to be open source. 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 It has now gotten quite popular, and that's great! But keeping it up to date, providing support, fixes
and new features takes a lot of time. 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:
I'm therefore kindly asking you to donate if you feel like you're getting a good tool A small montly amount through [![Donate with Patreon](images/patreon.png)](https://www.patreon.com/haugene) or
and you're able to spare some dollars to keep it functioning as it should. There's a couple of ways to do it: a one time donation with [![Donate with PayPal](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=73XHRSK65KQYC)
Become a patron, supporting the project with a small monthly amount. 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!
[![Donate with Patreon](images/patreon.png)](https://www.patreon.com/haugene)
Make a one time donation through PayPal.
[![Donate with PayPal](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=73XHRSK65KQYC)
Or use this referral code to DigitalOcean and get 25$ in credits, if you're interested in a cloud setup.
[![Credits on DigitalOcean](images/digitalocean.png)](https://m.do.co/c/ca994f1552bc)
You can also help out by submitting pull-requests or helping others with
open issues or in the gitter chat. A big thanks to everyone who has contributed so far!
And if you could be interested in joining as collaborator, let me know.