traefik/webui/readme.md
2024-05-21 15:26:04 +02:00

1.6 KiB

Traefik Web UI

Access to Traefik Web UI, ex: http://localhost:8080

Interface

Traefik Web UI provide 2 types of information:

  • Providers with their backends and frontends information.
  • Health of the web server.

How to build (for backend developer)

Use the make file :

make build-image                # Generate Docker image.
make clean-webui generate-webui # Generate static contents in `webui/static/` folder.

How to build (only for frontend developer)

  • prerequisite: Node 20.11+ Yarn 1.22.19

  • Go to the webui/ directory

  • To install dependencies, execute the following commands:

    • yarn install
  • Build static Web UI, execute the following command:

    • yarn build
  • Static contents are built in the webui/static/ directory

Do not manually change the files in the webui/static/ directory

  • The build allows to:
    • optimize all JavaScript
    • optimize all CSS
    • add vendor prefixes to CSS (cross-browser support)
    • add a hash in the file names to prevent browser cache problems
    • optimize all images at build time
    • bundle JavaScript in one file

How to edit (only for frontend developer)

Do not manually change the files in the webui/static/ directory

  • Go to the webui/ directory
  • Edit files in webui/src/
  • Run in development mode :
    • yarn dev

Libraries