You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Nick Satterly e7575af4f3 build(docker): Use correct docker image path 8 hours ago
.github build(docker): Use correct docker image path 8 hours ago
docs/images Add recent screenshot 2 years ago
public feat(search): save searches to user preferences (#412) 1 year ago
scripts Add deploy script for try.alerta.io 1 year ago
src feat: Add warning icon if blackout whole environments or all from origin (#508) 1 day ago
tests feat: Update workflows and lint/format configs (#489) 3 weeks ago
.browserslistrc First commit 3 years ago
.dockerignore build: use .dockerignore to exclude node_modules (#440) 11 months ago
.env.development Do not hard code ALERTA_ENDPOINT in build artefact 3 years ago
.eslintignore feat: Update workflows and lint/format configs (#489) 3 weeks ago
.eslintrc.js feat: Update workflows and lint/format configs (#489) 3 weeks ago
.eslintrc.json feat: Update workflows and lint/format configs (#489) 3 weeks ago
.gitignore First commit 3 years ago
.prettierignore feat: Update workflows and lint/format configs (#489) 3 weeks ago
.prettierrc.json feat: Update workflows and lint/format configs (#489) 3 weeks ago
CHANGELOG.md build: update changelog for v8.4.0 11 months ago
Dockerfile Pin docker build to node12 3 weeks ago
LICENSE Update README and add LICENSE 3 years ago
README.md build: add build and test status badge and minor fixes 11 months ago
VERSION build(docker): Docker image versioning & name change (#510) 8 hours ago
babel.config.js First commit 3 years ago
cypress.json First commit 3 years ago
jest.config.js fix translation for passed test:unit 2 years ago
nginx.conf Add nginx config to Docker to handle deep links 3 years ago
package-lock.json Bump version 8.6.2 -> 8.7.0 17 hours ago
package.json Bump version 8.6.2 -> 8.7.0 17 hours ago
postcss.config.js First commit 3 years ago
static.json Update heroku static config 2 years ago
tsconfig.json First commit 3 years ago
vue.config.js Add web UI version to About page 2 years ago

README.md

Alerta Web UI 7.0

Actions Status Slack chat

Version 7.0 of the Alerta web UI is a VueJS web app.

webui

Installation

To install the web console:

$ wget https://github.com/alerta/alerta-webui/releases/latest/download/alerta-webui.tar.gz
$ tar zxvf alerta-webui.tar.gz
$ cd dist
$ python3 -m http.server 8000

>> browse to http://localhost:8000

Configuration

Most configuration will come from the Alerta API server. The minimum, and most common, configuration is simply to tell the web UI where the API server is located.

Environment variables for some settings can be used at build time:

$ export VUE_APP_ALERTA_ENDPOINT=https://alerta-api.example.com
$ npm install
$ npm run build

or place a config.json configuration file in the dist directory for run time configuration:

{
    "endpoint": "https://alerta-api.example.com"
}

Any setting from the API server can be overridden if included in the local config.json file. For a full list of supported settings see the web UI config settings in the online docs.

As a special case, support for setting an OAuth Client ID using a build-time environment variable is possible but should not be be necessary for most deployments.

$ export VUE_APP_CLIENT_ID=0ffe5d26-6c66-4871-a6fa-593d9fa972b1

Quick Start

A docker container that is built using the most recent master branch is available for download from Docker Hub.

$ docker pull alerta/alerta-beta

It can also be built locally using the Dockerfile in this repository.

$ docker build -t alerta/alerta-beta .

To run, create a config.json file and mount the file into the container

$ echo '{"endpoint": "https://alerta-api.example.com"}' > config.json
$ docker run -v "$PWD/config.json:/usr/share/nginx/html/config.json" \
  -it -p 8000:80 --rm --name alerta-beta alerta/alerta-beta

Note: Update the CORS_ORIGINS setting in the Alerta API server config to include the URL that the beta web console is hosted at otherwise the browser will throw "blocked by CORS policy" errors and not work.

Deployment

Since this is a static web app then a production deployment of Alerta web UI is simply a matter of downloading the release tarball and copying the dist directory to the a location that can be served via a web server or CDN.

See the VueJS platform guide for more information.

Troubleshooting

The two main issues with deployment in production involve CORS and HTML5 history mode.

Cross-origin Errors (CORS)

All modern browsers restrict access of a web app running at one domain to resources at a different origin (domain). This mechanism is known as CORS.

To ensure that the Alerta web app has permission to access the Alerta API at a different origin the web URL needs to be added to the CORS_ORIGINS settings for the API.

See API server configuration for more details.

HTML5 History Mode

The web app uses HTML5 history mode so you must ensure to configure the web server or CDN correctly otherwise users will get 404 errors when accessing deep links such as /alert/:id directly in their browser.

The fix is to provide a catch-all fallback route so that any URL that doesn't match a static asset will be handled by the web app and redirected.

Example using nginx

location / {
  try_files $uri $uri/ /index.html;
}

Development

Project setup

npm install

Compiles and hot-reloads for development

npm run serve

Compiles and minifies for production

npm run build

Tests

Run your tests

npm run test

Lints and fixes files

npm run lint

Run your end-to-end tests

npm run test:e2e

Run your unit tests

npm run test:unit

License

Alerta monitoring system and console
Copyright 2019-2021 Nick Satterly

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.