Quick Start: Traefik Dashboard with Custom Domain

Posted on Edited on In Views:
how to configure custom domain for traefik dashboard

Quick Start: Traefik

Preparation

Create the necessary directories and files:

1
mkdir -p traefik/dynamic-conf && cd traefik && touch compose.yml traefik.yml dynamic-conf/self.yml

Configuration Files

compose.yml

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
services:
    traefik:
        image: traefik:3.1
        ports:
            - "80:80"
        environment:
            - TZ=Asia/Shanghai
        volumes:
            # /traefik.yml and /etc/traefik/traefik.yml are both available.
            - "./traefik.yml:/etc/traefik/traefik.yml"
            # dynamic-conf dir is self-defined
            - "./dynamic-conf:/etc/traefik/dynamic-conf"
            - "/var/run/docker.sock:/var/run/docker.sock:ro"
        networks:
            - traefik-net

networks:
    traefik-net:
        name: traefik-net
        ipam:
            config:
                -   subnet: 172.16.238.0/24

Note: Mounting the Docker socket (/var/run/docker.sock) can pose security risks. Consider using more secure alternatives in production environments.

traefik.yml

1
2
3
4
5
6
7
8
9
10
11
12
13
### Static Configuration
log:
    level: INFO
api:
    insecure: true  # Warning: Not recommended for production use
    dashboard: true
entryPoints:
    web:
        address: :80
providers:
    file:
        directory: /etc/traefik/dynamic-conf
        watch: true

Security Warning: insecure: true is not recommended for production environments. Consider setting up proper authentication for the API and dashboard.

self.yml in dir dynamic-conf

1
2
3
4
5
6
7
### Dynamic Configuration
http:
    routers:
        dashboard:
            rule: Host(`traefik.x.internal`)
            service: api@internal

DNS Configuration

Configure your DNS or modify your hosts file:

  • For Unix-like systems: Edit /etc/hosts
  • For Windows: Edit C:\Windows\System32\drivers\etc\hosts

Add the following line:

1
127.0.0.1 traefik.x.internal

Run

1
2
3
4
docker compose up -d
# Alternative commands:
# docker compose -p traefik up -d
# docker compose -f ./compose.yml -p traefik up -d

Access: http://traefik.x.internal