CE deploy & monitor web UI
This project provides a web interface for the CE deploy & monitor back-end, written in React.
Quickstart
npm ci
npm start
Requirements
- NodeJS and npm
- Credentials from ESS' Artifactory, with permissions to the ics-npm registry
Configuration
All necessary configuration is stored in a config file in the public
folder, called config.js. The config file has to be included in the index.html file.
The following values can be set in the file:
Environment variable | Description |
---|---|
SERVER_ADDRESS |
The backend server base URL (host:port) (if backend server is running natively on the same host as the UI then the value has to be empty, and proxy has to be set!) |
API_BASE_ENDPOINT |
The context path of the application's REST API (e.g. /api/spec) |
SUPPORT_URL |
The URL for where to ask for more support (i.e. service desk) |
TOKEN_RENEW_INTERVAL |
Time interval to renew JWT auth token (in milliseconds) |
NAMING_ADDRESS |
Naming service base URL (used for IOC name references feature) |
NETBOX_ADDRESS |
NetBox base URL (used for IOC host references) |
ENVIRONMENT_TITLE |
Adds a (sub)text to the HTLM title, and also for the appBar header. Supposed to show information to the user which environment they are using. The default value is empty. Optional field! |
FRONTEND_VERSION |
Version of application to display on help page |
Refering to a value in the JS source code is: window.field-name (e.g. window.SERVER_ADDRESS
).
Development
See DEVELOPMENT.md.