This tool will create a homepage for quick access to the domains where containers are exposed via traefik proxy using v2 configuration. (for old v1 configuration see here)

Domains are automatically retrieved reading traefik labels and only http(s) routers are supported.

Traefik is a reverse proxy that reads label on the docker compose file and automatically set up itself, so that you can access a service on a container with the specified hostname. Even though Traefik provides a dashboard that allow you to see services that are proxied, you still have to remember (or save somewhere) all the hostnames in order to access your services. This tool creates a Home page where all hostnames all listed, for easy access.

It uses docker-gen to monitor docker configuration changes and render a web page that will be served using nginx This way changes are immediately reflected whenever something gets updated.

For a quick preview you can just run the image with the following docker run command:

docker run --name traefik-home \
    -v /var/run/docker.sock:/var/run/docker.sock:ro \
    --label traefik.enable=true \
    --label traefik.http.routers.traefik-home.rule="Host(`home.example.com`)" \
    --label traefik.http.services.traefik-home.loadbalancer.server.port="80" \
    ghcr.io/santimar/traefik-home:latest

Wait for the service to be online, then go to home.example.com and enjoy the view.

For long runs however, the docker-compose file is a better approach.

version: '3'

services:
  traefik-home:
    image: ghcr.io/santimar/traefik-home:latest  # or use a specific tag version
    container_name: traefik-home
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock:ro
    labels:
      - traefik.enable="true"
      - traefik.http.routers.traefik-home.rule="Host(`home.example.com`)"
      - traefik.http.services.traefik-home.loadbalancer.server.port="80"

  other-service:
    image: ...
    labels:
      # see below for more info about exposed containers configuration
      - traefik-home.icon: "https://url/of/an/icon.png"
      - traefik-home.alias: "Alias"
    

The traefik-home container can be configured using the following optional labels.

Home will use the following traefik labels to generate the HTML page.

On each exposed container, the following optional labels can be added to provide a personalized configuration.

When a new release is available, just:

docker pull ghcr.io/santimar/traefik-home:latest

and then

docker-compose up -d traefik-home