metricq-webview
Graphing interface for MetricQ
Development
Installation
Update your global yarn installation (we need support for project-based yarn)
npm install -g yarn
Then the build system and the dependencies can be installed
yarn install
dev server
Use the automatically reloading dev server during development
yarn serve
override backend URL and authentication while developing
You can create a .env.development.local
file in the repository root to override the MetricQ backend url and authentication. This file is ignored by git and should never be committed.
VUE_APP_METRICQ_BACKEND=https://metricq-grafana/
VUE_APP_METRICQ_BACKEND_AUTH=user:pass
code style
We use standardJS, but since we need some global variables, the linter should be called like this:
yarn lint [--fix]
build for production
You can build the production version yourself download it as GitHub Actions artifacts
yarn build
Move the dist
folder content respectively the artifact content to your web server and make it available at /webview
.
override backend URL and authentication in production environment
You can edit the configuration.json
file next to the index.html
in the dist
folder to change the runtime configuration. At the moment the following fields are supported:
{
"backend": "<backend-url>",
"user": "<backend-user>",
"password": "<backend-password>"
}
For example:
{
"backend": "http://metricq-grafana",
"user": "webview",
"password": "SuperSecretPassword!"
}
The fields user
and password
are optional and can be omitted. The default for all fields is the build time configuration.
For the docker image, you can use the environment variables METRICQ_BACKEND, METRICQ_BACKEND_USER, and METRICQ_BACKEND_PASS to override the backend URL. Note though, that if you want to override METRICQ_BACKEND_USER and METRICQ_BACKEND_PASS, METRICQ_BACKEND has to be set as well.