fosrl/templates
1
0
Fork 0
mirror of https://github.com/fosrl/templates.git synced 2025-05-12 21:20:36 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

add gerbil, pangolin, and traefik templates

Browse source
This commit is contained in:
Milo Schwartz 2025-01-15 22:51:20 -05:00
parent ff5eeee5ab
commit 5b0a0d7409
No known key found for this signature in database
4 changed files with 115 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

34
unraid/gerbil.xml Normal file
View file

@ -0,0 +1,34 @@
<?xml version="1.0"?>
<Container version="2">
<Name>Gerbil</Name>
<Repository>fosrl/gerbil</Repository>
<Registry>https://hub.docker.com/r/fosrl/gerbil</Registry>
<Network>bridge</Network>
<MyIP/>
<Shell>sh</Shell>
<Privileged>false</Privileged>
<Support>https://github.com/fosrl/gerbil/issues</Support>
<Project>https://fossorial.io</Project>
<Overview>Gerbil (https://github.com/fosrl/gerbil) is a simple WireGuard interface management server written in Go. Gerbil makes it easy to create WireGuard interfaces as well as add and remove peers with an HTTP API. Gerbil is meant to enable the tunneling functionality of Pangolin (https://github.com/fosrl/pangolin), the tunneled reverse proxy server and dashboard UI with identity and access control.&#xD;
&#xD;
Chat with us on Discord!&#xD;
&#xD;
https://discord.gg/HCJR8Xhme4</Overview>
<Category>Security: Tools: Other: Network:Web Network:Proxy Network:VPN Network:Privacy Network:Other</Category>
<WebUI/>
<TemplateURL/>
<Icon>https://raw.githubusercontent.com/fosrl/pangolin/refs/heads/main/public/logo/pangolin_orange_512x512.png</Icon>
<ExtraParams>--cap-add=NET_ADMIN --cap-add=SYS_MODULE</ExtraParams>
<PostArgs>--generateAndSaveKeyTo=/var/config/key</PostArgs>
<CPUset/>
<DateInstalled>1736998830</DateInstalled>
<DonateText/>
<DonateLink/>
<Requires/>
<Config Name="Host Path 1" Target="/var/config" Default="" Mode="rw" Description="" Type="Path" Display="always" Required="false" Mask="false"></Config>
<Config Name="Reachable At" Target="REACHABLE_AT" Default="" Mode="" Description="How should the remote server reach Gerbil's API?" Type="Variable" Display="always" Required="false" Mask="false">http://gerbil:3003</Config>
<Config Name="Remote Config" Target="REMOTE_CONFIG" Default="" Mode="" Description="Remote config location to HTTP get the JSON based config from." Type="Variable" Display="always" Required="false" Mask="false">http://pangolin:3001/api/v1/gerbil/get-config</Config>
<Config Name="Report Bandwidth To" Target="REPORT_BANDWIDTH_TO" Default="" Mode="" Description="Remote HTTP endpoint to send peer bandwidth data." Type="Variable" Display="always" Required="false" Mask="false">http://pangolin:3001/api/v1/gerbil/receive-bandwidth</Config>
<Config Name="WireGuard Port" Target="51822" Default="" Mode="udp" Description="Port the WireGuard server will listen on" Type="Port" Display="always" Required="false" Mask="false">51822</Config>
<Config Name="HTTPS Port" Target="443" Default="" Mode="tcp" Description="Pass through port Traefik will listen on for https traffic" Type="Port" Display="always" Required="false" Mask="false">44301</Config>
<Config Name="HTTP Port" Target="80" Default="" Mode="tcp" Description="Pass through port Traefik will listen on for http traffic" Type="Port" Display="always" Required="false" Mask="false">8001</Config>

5
unraid/newt.xml
View file

@ -10,7 +10,10 @@
<Support>https://github.com/fosrl/newt/issues</Support>
<Project>https://fossorial.io</Project>
<Overview>Newt (https://github.com/fosrl/newt) is a user space tunnel client for the Pangolin (https://github.com/fosrl/pangolin) tunneled reverse proxy server. Newt is the entry point that allows you to safely expose your Unraid services to the internet through a reverse proxy tunnel!&#xD;
</Overview>
&#xD;
Chat with us on Discord!&#xD;
&#xD;
https://discord.gg/HCJR8Xhme4</Overview>
<Category>Security: Tools: Network:Web Network:Proxy Network:VPN Network:Privacy</Category>
<WebUI/>
<TemplateURL/>

39
unraid/pangolin.xml Normal file
View file

@ -0,0 +1,39 @@
<?xml version="1.0"?>
<Container version="2">
<Name>Pangolin</Name>
<Repository>fosrl/pangolin</Repository>
<Registry>https://hub.docker.com/r/fosrl/pangolin</Registry>
<Network>bridge</Network>
<MyIP/>
<Shell>sh</Shell>
<Privileged>false</Privileged>
<Support>https://github.com/fosrl/pangolin/issues</Support>
<Project>https://fossorial.io</Project>
<Overview>Pangolin (https://github.com/fosrl/pangolin) is a tunneled reverse proxy server and dashboard UI with identity and access control built in. Pangolin can optionally be used in Local mode as a normal reverse proxy for users who don't want/need tunnels, but still want to take advantage of its excellent authentication features.&#xD;
&#xD;
Chat with us on Discord!&#xD;
&#xD;
https://discord.gg/HCJR8Xhme4</Overview>
<Category>Security: Tools: Network:Web Network:Proxy Network:Management Network:VPN Network:Other</Category>
<WebUI>http://[IP]:[PORT:3002]</WebUI>
<TemplateURL/>
<Icon>https://raw.githubusercontent.com/fosrl/pangolin/refs/heads/main/public/logo/pangolin_orange_512x512.png</Icon>
<ExtraParams/>
<PostArgs/>
<CPUset/>
<DateInstalled>1736998906</DateInstalled>
<DonateText/>
<DonateLink/>
<Requires/>
<Config Name="Config" Target="/app/config" Default="" Mode="rw" Description="" Type="Path" Display="always" Required="false" Mask="false"></Config>
<Config Name="Dashboard URL" Target="APP_DASHBOARDURL" Default="" Mode="" Description="This the external URL by which you will access the Pangolin dashboard for management and authentication" Type="Variable" Display="always" Required="false" Mask="false">https://pangolin.example.com</Config>
<Config Name="Base Domain" Target="APP_BASEDOMAIN" Default="" Mode="" Description="This is the base domain to be used as the root of all subdomains" Type="Variable" Display="always" Required="false" Mask="false">example.com</Config>
<Config Name="Gerbil Base Endpoint" Target="GERBIL_BASEENDPOINT" Default="" Mode="" Description="" Type="Variable" Display="always" Required="false" Mask="false">pangolin.example.com</Config>
<Config Name="Server Admin Email" Target="USERS_SERVERADMIN_EMAIL" Default="" Mode="" Description="This user will be considered the server admin" Type="Variable" Display="always" Required="false" Mask="false">admin@example.com</Config>
<Config Name="Server Admin Password" Target="USERS_SERVERADMIN_PASSWORD" Default="" Mode="" Description="" Type="Variable" Display="always" Required="false" Mask="true">Password123!</Config>
<Config Name="Generate Traefik Config" Target="GENERATE_TRAEFIK_CONFIG" Default="" Mode="" Description="This will generate basic Traefik config files for use with Pangolin at /traefik. This will overwrite any manual changes you make to the files. WARNING: Disable this if you make any manual edits to the Pangolin Traefik config files" Type="Variable" Display="always" Required="false" Mask="false">true</Config>
<Config Name="Host Port 1" Target="3002" Default="" Mode="tcp" Description="NOTE: If you change this, the container port and SERVER_NEXTPORT must match" Type="Port" Display="always" Required="false" Mask="false">3002</Config>
<Config Name="Host Port 2" Target="3000" Default="" Mode="tcp" Description="NOTE: If you change this, the container port and SERVER_NEXTPORT must match" Type="Port" Display="always" Required="false" Mask="false">3000</Config>
<Config Name="Host Port 3" Target="3001" Default="" Mode="tcp" Description="NOTE: IF you change this, the container port and SERVER_INTERNALPORT must match" Type="Port" Display="always" Required="false" Mask="false">3001</Config>
<Config Name="Gerbil WireGuard Port" Target="GERBIL_STARTPORT" Default="" Mode="" Description="" Type="Variable" Display="always" Required="false" Mask="false">51822</Config>
</Container>

38
unraid/traefik.xml Normal file
View file

@ -0,0 +1,38 @@
<?xml version="1.0"?>
<Container version="2">
<Name>Traefik</Name>
<Repository>traefik:latest</Repository>
<Registry>https://hub.docker.com/_/traefik</Registry>
<Network>none</Network>
<MyIP/>
<Shell>sh</Shell>
<Privileged>false</Privileged>
<Support/>
<Project>https://traefik.io/</Project>
<Overview>This Traefik template is designed to simplify the Pangolin (https://github.com/fosrl/pangolin) setup process for Fossorial apps.&#xD;
&#xD;
Chat with us on Discord!&#xD;
&#xD;
https://discord.gg/HCJR8Xhme4&#xD;
&#xD;
To route Traefik through Gerbil:&#xD;
&#xD;
--net=container:Gerbil</Overview>
<Category>Productivity: Security: Tools:Utilities Network:Proxy</Category>
<WebUI>http://[IP]:[PORT:8080]/</WebUI>
<TemplateURL>https://raw.githubusercontent.com/ibracorp/unraid-templates/master/traefik/traefik.xml</TemplateURL>
<Icon>https://raw.githubusercontent.com/ibracorp/unraid-templates/master/icons/traefik.png</Icon>
<ExtraParams/>
<PostArgs>--configFile=/etc/traefik/traefik_config.yml</PostArgs>
<CPUset/>
<DateInstalled>1736999419</DateInstalled>
<DonateText/>
<DonateLink/>
<Requires/>
<Config Name="Config Folder" Target="/etc/traefik" Default="/mnt/user/appdata/traefik" Mode="rw" Description="Appdata Location" Type="Path" Display="always" Required="false" Mask="false"></Config>
<Config Name="https Port" Target="443" Default="44301" Mode="tcp" Description="HTTPS Port" Type="Port" Display="always" Required="false" Mask="false">44301</Config>
<Config Name="http Port" Target="80" Default="8001" Mode="tcp" Description="HTTP Port" Type="Port" Display="always" Required="false" Mask="false">8001</Config>
<Config Name="Web UI Port" Target="8080" Default="8183" Mode="tcp" Description="Dashboard WebUI Port" Type="Port" Display="always" Required="false" Mask="false">8183</Config>
<Config Name="Enable Traefik (Dashboard)" Target="traefik.enable" Default="true" Mode="" Description="Enable/Disable Traefik Dashboard" Type="Label" Display="always" Required="false" Mask="false">true</Config>
<Config Name="Host Path 2" Target="/letsencrypt" Default="" Mode="rw" Description="" Type="Path" Display="always" Required="false" Mask="false"></Config>
</Container>