5b2e8990f1
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>
80 lines
2.2 KiB
Markdown
80 lines
2.2 KiB
Markdown
# 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 :
|
|
|
|
```shell
|
|
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+](https://nodejs.org) [yarn](https://yarnpkg.com/)
|
|
|
|
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
|
|
|
|
- [Node](https://nodejs.org)
|
|
- [Yarn](https://yarnpkg.com/)
|
|
- [Generator FountainJS](https://github.com/FountainJS/generator-fountain-webapp)
|
|
- [Webpack](https://github.com/webpack/webpack)
|
|
- [AngularJS](https://docs.angularjs.org/api)
|
|
- [UI Router](https://github.com/angular-ui/ui-router)
|
|
- [UI Router - Documentation](https://github.com/angular-ui/ui-router/wiki)
|
|
- [Bootstrap](http://getbootstrap.com)
|
|
- [Angular Bootstrap](https://angular-ui.github.io/bootstrap)
|
|
- [D3](http://d3js.org)
|
|
- [D3 - Documentation](https://github.com/mbostock/d3/wiki)
|
|
- [NVD3](http://nvd3.org)
|
|
- [Angular nvD3](http://krispo.github.io/angular-nvd3)
|