traefik/webui/readme.md
Gaetan Semet 5b2e8990f1 prefere yarnpkg over yarn
to avoid conflict with Hadoop Yarn cli.

I don’t know the best practice, but i do
have Apache Yarn installed on my machine, so
I get this conflict. Of course this conflict does
not arised when building within the docker.

https://github.com/yarnpkg/yarn/issues/2337
Signed-off-by: Gaetan Semet <gaetan@xeberon.net>
2017-05-10 17:35:17 +02:00

2.2 KiB

Træfik Web UI

Access to Træfik Web UI, ex: http://localhost:8080

Interface

Træfik Web UI provide 2 types of informations:

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

How to build (for backends developer)

Use the make file :

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

How to build (only for frontends developer)

  • prerequisite: Node 4+ yarn

    Note: In case of conflict with the Apache Hadoop Yarn Command Line Interface, use the yarnpkg alias.

  • Go to the directory webui

  • To install dependencies, execute the following commands:

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

    • yarn run build
  • Static contents are build in the directory static

Don't change manually the files in the directory static

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

How to edit (only for frontends developer)

Don't change manually the files in the directory static

  • Go to the directory webui

  • Edit files in webui/src

  • Run in development mode :

    • yarn run serve
  • Træfik API connections are defined in:

    • webui/src/app/core/health.resource.js
    • webui/src/app/core/providers.resource.js
  • The pages contents are in the directory webui/src/app/sections.

Libraries