AppFeed/templates/ich777sRepository/ich777/OpenVPN-Client.xml
Squidly271 b3878cd225 Redo
2020-12-03 07:42:32 -05:00

57 lines
5.4 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<Container version="2">
<Name>OpenVPN-Client</Name>
<Repository>dperson/openvpn-client</Repository>
<Registry>https://hub.docker.com/r/dperson/openvpn-client/</Registry>
<Network>bridge</Network>
<Shell>sh</Shell>
<Privileged>false</Privileged>
<Support>https://forums.unraid.net/topic/83786-support-ich777-application-dockers/</Support>
<Project>https://hub.docker.com/r/dperson/openvpn-client</Project>
<Overview>This OpenVPN container was designed to be started first to provide a connection to other containers (using '--net=container:OpenVPN-Client'), see the documentation for further help here: https://hub.docker.com/r/dperson/openvpn-client&#13;
&#13;
The basic steps for a OpenVPN connection that requires a Username and Password are: 1) Rename your *.ovpn to 'vpn.ovpn' and place it in your OpenVPN-Client directory, 2) Create in the same directory a file named 'vpn.auth' and place your Username in the first line and the Password for the connection in the second line and save it 3) Restart the container open the logs and see if the connection to your VPN establishes successfully.&#13;
&#13;
To tunnel traffic from another container through this container edit the template from the other container, set the 'Network Type' to: 'None', enable the advanced view in the top right corner and at 'Extra Parameters' add the following: '--net=container:OpenVPN-Client' (replace 'OpenVPN-Client' with the name of this container if you choose a different name for it) and write down the port(s) that you need to connect to.&#13;
After that go back to edit this containers template and add the port that you have noted in the above step to this container and click 'Apply' now you can connect to the container that you tunneld the traffic though this container.&#13;
&#13;
You can route the traffic from multiple containers through this container with the steps above, if you need more ports then simply add more ports in this containers template.&#13;
&#13;
DNS: By default this container uses Googles DNS Server: 8.8.8.8 if you want to edit this enable the advanced view and edit this setting at 'Extra Parameters'.&#13;
&#13;
ADVANCED CONFIG: If you leave the appdata directory for this container empty it will start up and you have to manually configure it with the builtin comand: 'openvpn.sh', see: https://hub.docker.com/r/dperson/openvpn-client</Overview>
<WebUI></WebUI>
<Icon>https://raw.githubusercontent.com/ich777/docker-templates/master/ich777/images/openvpn-client.png</Icon>
<ExtraParams>--cap-add=NET_ADMIN --dns=8.8.8.8</ExtraParams>
<PostArgs></PostArgs>
<CPUset></CPUset>
<Networking>
<Mode>bridge</Mode>
<Publish></Publish>
</Networking>
<Data>
<Volume>
<HostDir>/mnt/cache/appdata/openvpn-client</HostDir>
<ContainerDir>/vpn</ContainerDir>
<Mode>rw</Mode>
</Volume>
</Data>
<Environment></Environment>
<Config Name="Data Path" Target="/vpn" Default="" Mode="rw" Description="Data Path for your 'vpn.ovpn' and your certificates or your 'vpn.auth'." Type="Path" Display="always" Required="true" Mask="false">/mnt/cache/appdata/openvpn-client</Config>
<Config Name="TUN device" Target="" Default="" Mode="" Description="TUN device that is needed to run the container." Type="Device" Display="advanced" Required="true" Mask="false">/dev/net/tun</Config>
<Category>Network:VPN</Category>
<Description>This OpenVPN container was designed to be started first to provide a connection to other containers (using '--net=container:OpenVPN-Client'), see the documentation for further help here: https://hub.docker.com/r/dperson/openvpn-client&#13;
&#13;
The basic steps for a OpenVPN connection that requires a Username and Password are: 1) Rename your *.ovpn to 'vpn.ovpn' and place it in your OpenVPN-Client directory, 2) Create in the same directory a file named 'vpn.auth' and place your Username in the first line and the Password for the connection in the second line and save it 3) Restart the container open the logs and see if the connection to your VPN establishes successfully.&#13;
&#13;
To tunnel traffic from another container through this container edit the template from the other container, set the 'Network Type' to: 'None', enable the advanced view in the top right corner and at 'Extra Parameters' add the following: '--net=container:OpenVPN-Client' (replace 'OpenVPN-Client' with the name of this container if you choose a different name for it) and write down the port(s) that you need to connect to.&#13;
After that go back to edit this containers template and add the port that you have noted in the above step to this container and click 'Apply' now you can connect to the container that you tunneld the traffic though this container.&#13;
&#13;
You can route the traffic from multiple containers through this container with the steps above, if you need more ports then simply add more ports in this containers template.&#13;
&#13;
DNS: By default this container uses Googles DNS Server: 8.8.8.8 if you want to edit this enable the advanced view and edit this setting at 'Extra Parameters'.&#13;
&#13;
ADVANCED CONFIG: If you leave the appdata directory for this container empty it will start up and you have to manually configure it with the builtin comand: 'openvpn.sh', see: https://hub.docker.com/r/dperson/openvpn-client</Description>
<templatePath>/tmp/GitHub/AppFeed/templates/ich777sRepository/ich777/OpenVPN-Client.xml</templatePath>
</Container>