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

Update instructions for custom provider after comments in #1039

Browse Source
This commit is contained in:
Kristian Haugene
2020-03-29 16:34:13 +02:00
parent 030f9cf007
commit ca52396e31
1 changed files with 12 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

15
docs/supported-providers.md
View File

@@ -73,9 +73,17 @@ If you want to run the image with your own provider without building a new image
Add a new volume mount to your `docker run` command that mounts your config file: Add a new volume mount to your `docker run` command that mounts your config file:
`-v /path/to/your/config.ovpn:/etc/openvpn/custom/default.ovpn` `-v /path/to/your/config.ovpn:/etc/openvpn/custom/default.ovpn`
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. Then you can set `OPENVPN_PROVIDER=CUSTOM`and the container will use the config you provided.
NOTE: Your .ovpn config file probably contains a line that says `auth-user-pass`. This will prompt OpenVPN to ask for the
username and password. As this is running in a scripted environment that is not possible. Change it for `auth-user-pass /config/openvpn-credentials.txt`
which is the file where your `OPENVPN_USERNAME` and `OPENVPN_PASSWORD` variables will be written to.
Note that you still need to modify your .ovpn file as described in the previous section. If you have an separate ca.crt, client.key or client.crt file in your volume mount should be a folder containing both the ca.crt and the .ovpn config. 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 as described in the previous section.
If you have an separate ca.crt, client.key or client.crt file in your volume mount should be a folder containing both the ca.crt and the .ovpn config.
Mount the folder contianing all the required files instead of the openvpn.ovpn file. Mount the folder contianing all the required files instead of the openvpn.ovpn file.
`-v /path/to/your/config/:/etc/openvpn/custom/` `-v /path/to/your/config/:/etc/openvpn/custom/`
@@ -83,4 +91,5 @@ Mount the folder contianing all the required files instead of the openvpn.ovpn f
Additionally the .ovpn config should include the full path on the docker container to the ca.crt and additional files. Additionally the .ovpn config should include the full path on the docker container to the ca.crt and additional files.
`ca /etc/openvpn/custom/ca.crt` `ca /etc/openvpn/custom/ca.crt`
If `-e OPENVPN_CONFIG=` variable has been omitted from the `docker run` command the .ovpn config file must be named default.ovpn. IF `-e OPENVPN_CONFIG=` is used with the custom provider the .ovpn config and variable must match as described above. If `-e OPENVPN_CONFIG=` variable has been omitted from the `docker run` command the .ovpn config file must be named default.ovpn.
If `-e OPENVPN_CONFIG=` is used with the custom provider the .ovpn config and variable must match as described above.