AppFeed/templates/DyonsRepository/Templates/passthroughvpn/passthroughvpn-template.xml
2021-02-23 15:49:21 -05:00

42 lines
5.4 KiB
XML

<?xml version="1.0" encoding="UTF-8"?>
<Container version="2">
<Date>1613710800</Date>
<Name>passthroughvpn</Name>
<Repository>dyonr/passthroughvpn</Repository>
<Registry>https://hub.docker.com/r/dyonr/passthroughvpn</Registry>
<Network>bridge</Network>
<Shell>bash</Shell>
<Privileged>true</Privileged>
<Support>https://forums.unraid.net/topic/102916-support-dyonr-passthroughvpn/</Support>
<Project>https://github.com/DyonR/docker-passthroughvpn</Project>
<Overview>This container solves the problem of containers with no 'VPN' variant. After setting up this container, route your non-VPN Dockers through this one to protect your IP.&#13;
Or host, for example a game or webserver by using your VPN Provider's IP, if your VPN Provider supports forwarding.&#13;
Both WireGuard and OpenVPN are supported.&#13;
Check out https://github.com/DyonR/docker-passthroughvpn for more information and setup instructions.&#13;
ANY CONTAINER THAT GETS ROUTED THROUGH THIS CONTAINER WILL (BRIEFLY) USE YOUR REAL IP. THIS IS BECAUSE THE PASSTHROUGHVPN CONTAINER NEEDS TO ESTABLISH A CONNECTION WITH THE VPN FIRST. TILL THE VPN CONNECTION IS ESTABLISHED, IT WILL USE YOUR REAL IP.</Overview>
<TemplateURL>https://raw.githubusercontent.com/DyonR/docker-templates/master/Templates/passthroughvpn/passthroughvpn-template.xml</TemplateURL>
<Icon>https://raw.githubusercontent.com/DyonR/docker-templates/master/Icons/passthroughvpn/passthroughvpn-icon-256.png</Icon>
<ExtraParams>--restart unless-stopped</ExtraParams>
<Config Name="VPN_ENABLED" Target="VPN_ENABLED" Default="yes" Mode="" Description="Enable VPN? yes/no" Type="Variable" Display="always" Required="false" Mask="false">yes</Config>
<Config Name="VPN_TYPE" Target="VPN_TYPE" Default="openvpn" Mode="" Description="openvpn / wireguard?" Type="Variable" Display="always" Required="true" Mask="false">openvpn</Config>
<Config Name="VPN_USERNAME" Target="VPN_USERNAME" Default="" Mode="" Description="Username used to authenticate to the VPN (OpenVPN only)" Type="Variable" Display="always" Required="false" Mask="false"></Config>
<Config Name="VPN_PASSWORD" Target="VPN_PASSWORD" Default="" Mode="" Description="Password used to authenticate to the VPN (OpenVPN only)" Type="Variable" Display="always" Required="false" Mask="true"></Config>
<Config Name="LAN_NETWORK" Target="LAN_NETWORK" Default="192.168.0.0/24" Mode="" Description="Your local network address in CIDR notation" Type="Variable" Display="always" Required="true" Mask="false">192.168.0.0/24</Config>
<Config Name="ADDITIONAL_PORTS" Target="ADDITIONAL_PORTS" Default="" Mode="" Description="A comma delimited list of ports that need to be accessible." Type="Variable" Display="always" Required="false" Mask="false"></Config>
<Config Name="RESTART_CONTAINER" Target="RESTART_CONTAINER" Default="" Mode="" Description="If set to 'yes', the container will restart itself when connection is lost" Type="Variable" Display="always" Required="false" Mask="false">no</Config>
<Config Name="PUID" Target="PUID" Default="99" Mode="" Description="The UID applied to /config" Type="Variable" Display="always" Required="false" Mask="false">99</Config>
<Config Name="PGID" Target="PGID" Default="100" Mode="" Description="The GID applied to /config" Type="Variable" Display="always" Required="false" Mask="false">100</Config>
<Config Name="NAME_SERVERS" Target="NAME_SERVERS" Default="1.1.1.1,1.0.0.1" Mode="" Description="DNS used by the container" Type="Variable" Display="advanced" Required="false" Mask="false">1.1.1.1,1.0.0.1</Config>
<Config Name="UMASK" Target="UMASK" Default="002" Mode="" Description="umask used by the container" Type="Variable" Display="advanced" Required="false" Mask="false">002</Config>
<Config Name="HEALTH_CHECK_HOST" Target="HEALTH_CHECK_HOST" Default="one.one.one.one" Mode="" Description="Host used to check if connection is up" Type="Variable" Display="advanced" Required="false" Mask="false">one.one.one.one</Config>
<Config Name="HEALTH_CHECK_INTERVAL" Target="HEALTH_CHECK_INTERVAL" Default="300" Mode="" Description="Interval in seconds between connection check" Type="Variable" Display="advanced" Required="false" Mask="false">300</Config>
<Config Name="HEALTH_CHECK_SILENT" Target="HEALTH_CHECK_SILENT" Default="1" Mode="" Description="1 supresses the 'Network is up' message" Type="Variable" Display="advanced" Required="false" Mask="false">1</Config>
<Config Name="config" Target="/config" Default="/mnt/user/appdata/passthroughvpn/" Mode="rw" Description="config path of passthroughvpn" Type="Path" Display="advanced" Required="true" Mask="false">/mnt/user/appdata/passthroughvpn/</Config>
<Description>This container solves the problem of containers with no 'VPN' variant. After setting up this container, route your non-VPN Dockers through this one to protect your IP.&#13;
Or host, for example a game or webserver by using your VPN Provider's IP, if your VPN Provider supports forwarding.&#13;
Both WireGuard and OpenVPN are supported.&#13;
Check out https://github.com/DyonR/docker-passthroughvpn for more information and setup instructions.&#13;
ANY CONTAINER THAT GETS ROUTED THROUGH THIS CONTAINER WILL (BRIEFLY) USE YOUR REAL IP. THIS IS BECAUSE THE PASSTHROUGHVPN CONTAINER NEEDS TO ESTABLISH A CONNECTION WITH THE VPN FIRST. TILL THE VPN CONNECTION IS ESTABLISHED, IT WILL USE YOUR REAL IP.</Description>
<templatePath>/tmp/GitHub/AppFeed/templates/DyonsRepository/Templates/passthroughvpn/passthroughvpn-template.xml</templatePath>
</Container>