TraefikLens/configuration.example.yml at main · karam-ajaj/TraefikLens · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
version: 2.0

# Connection to the Traefik API
traefik:
  api_url: "http://traefik:8080/api"
  refresh_interval: 5
  timeout: 5

# Dashboard appearance
dashboard:
  title: "TraefikLens Dashboard"
  default_theme: "dynamic"  # light | dark | dynamic

# Icon configuration
icons:
  default_icon: "mdi:web"
  dynamic:
    enabled: true
    base_url: "https://cdn.jsdelivr.net/gh/homarr-labs/dashboard-icons/svg/"
    extension: ".svg"
    slug_strategy: "service"  # service | name | both
  rules:
    - pattern: ".*api.*"
      icon: "mdi:api"
    - pattern: ".*dashboard.*"
      icon: "mdi:monitor-dashboard"
    - pattern: ".*admin.*"
      icon: "mdi:shield-account"
    - pattern: ".*blog.*"
      icon: "mdi:post"
    - pattern: ".*shop.*|.*store.*"
      icon: "mdi:cart"
    - pattern: ".*mail.*|.*email.*"
      icon: "mdi:email"
    - pattern: ".*auth.*|.*login.*"
      icon: "mdi:login"
    - pattern: ".*docs.*|.*documentation.*"
      icon: "mdi:file-document"
    - pattern: ".*git.*"
      icon: "mdi:git"
    - pattern: ".*cloud.*"
      icon: "mdi:cloud"

# Category resolution from Traefik labels
categories:
  label_key: "traefiklens.category"
  additional_keys:
    - "traefiklens_category"
  rules:
    - pattern: "media"
      category: "Media"
    - pattern: "^auth-.*"
      category: "Security"

# Services configuration
services:
  # Exclude routes by regex (matched against the displayed name)
  exclude:
    - "-https@"         # matches routes ending in -https@
    - "api.*"           # exclude routes starting with api

  # Override names or icons for discovered services
  overrides:
    - service: "example-service"
      display_name: "Example Friendly Name"
      icon: "my-icon.svg"   # relative to dynamic icon base OR full URL
      category: "My Category"

  # Define manual services that are not known to Traefik
  manual:
    - name: "glances"
      url: "https://st.vnerd.nl"
      icon: "glances.svg"
      priority: 10
      category: "monitoring"

  # Optional label filters applied when processing Traefik routes
  labels:
    - "traefiklens.category=media"

  # Control how router names are displayed
  display:
    strip_provider_suffix: true    # remove @docker/@internal suffixes
    strip_suffixes:
      - "-http"                   # remove protocol suffixes before provider
      - "-https"
      - "-tcp"