TraefikShaper

TraefikShaper

Docker app from grtgbln's Repository

Overview

Docker container to manipulate Traefik's IpAllowList middleware for dynamic IP whitelisting

Requirements


        Expects a dynamic whitelist YAML file at the "Whitelist File" path.
    

Runtime arguments

Network
bridge
Privileged
false

Template configuration

App PortPorttcp

Container Port: 5000

Target
5000
Default
5000
Value
5000
App URLVariable

URL of the app. Replace with domain (ex. https://traefikshaper.example.com)

Target
APPURL
Default
http://localhost:5000
Value
http://localhost:5000
Access Request EndpointVariable

Endpoint for clients to request access (ex. /knock-knock)

Target
GRANT_HTTP_ENDPOINT
Allow Private Class SubnetsVariable

Add private class subnets to the IPAllowList

Target
DEFAULT_PRIVATE_CLASS_SOURCE_RANGE
Default
True|False
Depth IP StrategyVariable

The depth ip strategy used in the IPAllowList middleware. Use 1 if traefik runs behind another proxy (e.g. CloudFlare)

Target
IPSTRATEGY_DEPTH
Default
0
Value
0
Expiration TimeVariable

How long access is granted, in seconds

Target
EXPIRATION_TIME
Default
300
Value
300
Apprise Notification URLVariable

Your preferred apprise url. See documentation: https://github.com/caronc/apprise

Target
APPRISE_NOTIFICATION_URL
Enable TraefikLabel

Enable Traefik

Target
traefik.enable
Default
true
Docker NetworkLabel

Docker network

Target
traefik.docker.network
Router RuleLabel

Router rule (ex. Host(`traefikshaper.example.com`))

Target
traefik.http.routers.traefikshaper.rule
Whitelist FilePathrw

Path to the dynamic whitelist file

Target
/app/dynamic-whitelist.yml
Router Service NameLabel

Router service name

Target
traefik.http.routers.traefikshaper.service
Default
traefikshaper
Value
traefikshaper
Loadbalancer PortLabel

Loadbalancer port

Target
traefik.http.services.traefikshaper.loadbalancer.server.port
Default
5000
Value
5000
Local TimePathro

Container local time

Target
/etc/localtime
Default
/etc/localtime
Value
/etc/localtime
TimezonePathro

Container timezone

Target
/etc/timezone
Default
/etc/timezone
Value
/etc/timezone

Download Statistics

500
Total Downloads

Details

Repository
l4rm4nd/traefikshaper:latest
Last Updated2024-08-30
First Seen2024-10-04

Run TraefikShaper on Unraid.

TraefikShaper is listed in Community Apps for Unraid OS. Explore Unraid to build a flexible home server, NAS, or homelab.