Documentation

Configuration File Description

You can customize vendor information, including the system name and device model. Modifying the configuration file affects the WebUI display. The customized images uploaded by users affect the WebUI display.

The structure of the directory ({project_dir}/src/app/add_customized_web_assets) of the customizing vendor information configuration file and customized images is as follows:

{project_dir}/src/app/add_customized_web_assets
├── WhiteboxConfig
│   ├── img                                       # Directory for storing customized images
│      ├── device.png
│      ├── device-en.png
│      ├── favicon.ico
│      ├── login.png
│      ├── logo.png
│      └── model.svg
│   ├── json                                       # Directory for storing the configuration file of customized vendor information
│      └── config.json
├── build_customized_web_assets.sh             # Script configuration
The customized vendor information configuration file config.json is stored in {project_dir}/src/app/add_customized_web_assets/WhiteboxConfig/json. The format is as follows: 
{
  "model": "",
  "systemName": {
    "zh": "",
    "en": ""
  },
  "websiteTitle": {
    "zh": "",
    "en": ""
  },
  "userGuide": {
    "zh": "",
    "en": ""
  },
  "copyRight": {
    "zh": "",
    "en": "."
  }
}
Table 1 Configuration parameters

Parameter

Description

model

Device model. The parameter name cannot be modified. The parameter value can contain 1 to 128 characters, including uppercase letters, lowercase letters, digits, spaces, and parentheses.

systemName

System name. The parameter name cannot be modified.

websiteTitle

Website title. The parameter name cannot be modified.

userGuide

Name of the system user guide. The parameter name cannot be modified.

copyRight

Copyright description. The parameter name cannot be modified.

zh

Chinese description of a field. The value can contain 1 to 128 characters, including uppercase letters, lowercase letters, digits, spaces, Chinese characters, and Chinese/English parentheses.

en

English description of a field. The value can contain 1 to 128 characters, including uppercase letters, lowercase letters, digits, spaces, parentheses, dots (.), and commas (,).

The following figures show the positions of the preceding customized vendor information on the edge management system web page.

The content of the model field is not displayed on the WebUI. Instead, it is displayed in the name of the exported log package.

Figure 1 systemName
Figure 2 websiteTitle
Figure 3 userGuide
Figure 4 copyRight