.traefik.yml

displayName: Sablier
type: middleware
iconPath: ./assets/icon.png
bannerPath: ./assets/banner.png

import: github.com/sablierapp/sablier-traefik-plugin

summary: "Start your containers on demand, shut them down automatically when there's no activity. Docker, Docker Swarm Mode and Kubernetes compatible."

testData:
  sablierUrl: http://sablier:10000  # The sablier URL service, must be reachable from the Traefik instance
  names: whoami,nginx               # Comma separated names of containers/services/deployments etc.
  group: default                    # Group name to use to filter by label, ignored if names is set
  sessionDuration: 1m               # The session duration after which containers/services/deployments instances are shutdown
  keepAliveInterval: 30s            # (optional) How often Sablier is pinged to renew the session while a long-lived connection (SSE, WebSocket, long-polling) is held. Should be shorter than `sessionDuration`. Disabled when omitted.
  failOpen: false                   # (optional) Pass requests through to the backend when Sablier is unreachable instead of returning HTTP 500.
  ignoreUserAgent:                  # (optional) List of Go regexp patterns; requests whose User-Agent matches any pattern are passed through immediately without waking containers.
    - curl
    - "(?i)uptimerobot"
  # You can only use one strategy at a time
  # To do so, only declare `dynamic` or `blocking`

  # Dynamic strategy, provides the waiting webui
  dynamic:
    displayName: My Title       # (Optional) Defaults to the middleware name
    showDetails: true           # (Optional) Set to true or false to show details specifcally for this middleware, unset to use Sablier server defaults
    theme: hacker-terminal      # (Optional) The theme to use
    refreshFrequency: 5s        # (Optional) The loading page refresh frequency

  # Blocking strategy, waits until services are up and running
  # but will not wait more than `timeout`
  # blocking: 
  #   timeout: 1m