Some elements of SAYMON web interface can be configured in the client configuration file /usr/local/saymon/client/client-config.js.
In some cases the file client-config.js can be stored in another directory. The directory can be found by either checking the nginx configuration file or using the following command:
sudo find / -name "client-config.js"
| Section/Parameter | Description |
|---|---|
| agentInstallerUrl | A link to download an agent installation script. |
authEnabled | It activates manual registration for users;
By default false | registration is disabled. |
Authentication | This section allows to set authentication methods for SAYMON users. authentication: {
availableMethods: ["native", "keycloak"],
methodByDefault: "keycloak",
services: {
keycloak: {
configUri: "keycloak_frontend.json",
legacySupport: false
}
}
}
|
| authentication.availableMethods | List of authentication methods available for users:
By default only "native" is used. |
| authentication.methodByDefault | Authentication method offered to users when the authentication form is displayed. By default "native". |
authentication.services | Section with settings for authentication services. |
authentication. | Section with settings for authentication via Keycloak. |
| authentication.services.keycloak. configUri | Name of the configuration file, generated by the Keycloak server for the Frontend-client. The file must be placed on the SAYMON server in the directory with the client-config.js file |
| authentication.services.keycloak. legacySupport | It enables support for working with Keycloak-server version below 19;
By default false | support for working with Keycloak server version below 19 is disabled. |
| canEditObjectStyle | It allows to configure CSS styles for objects and links. With the option is enabled, the section Parameters contains the subsection Style (of objects, links). |
| collapseSections | It specifies the way sections and graphs are displayed:
By default true | sections are unpinned, graphs are hidden. |
Comet | Along with REST API, SAYMON uses the Comet model to exchange data between the client and the server. comet: {
port: 8091,
url: [
"https://cpult.ru/ws",
"http://10.78.5.11:8092"
]
},
...
|
| comet.port | Port number which the client connects to the Comet server by. By default 8091. |
| comet.url | Addresses for connecting the clients to the Comet server from different networks. The comet.port parameter is ignored while using the comet.url parameter. |
DefaultClassImage | It allows to set a standard icon and its size for objects of a particular class. defaultClassImage: {
'29': { img: '/images/cloud.svg', dim: [100, 75] }
},
...
|
| defaultClassImage.'<number>' | Class identificator, for example, 29. |
defaultClassImage.'<number>'. | Path to the image relatively to the directory where the configuration file is located. |
| defaultClassImage.'<number>'. dim | Size of the image (in pixels, [width, height]). |
DefaultEmbeddableLink | It allows to embed widgets with information about objects to external resources. defaultEmbeddableLink: {
url: "http://saymon.info/",
name: "SAYMON"
},
...
|
defaultEmbeddableLink.name | Name of the widget. |
defaultEmbeddableLink.url | URL to which the widget refers. |
defaultPieChartColors | Default colors for pie chart (Circle): defaultPieChartColors: [
'#a90329',
'#3276b1',
'#009F3D',
'#9868B8',
'#F2C001',
'#FF742C',
'#90574E',
'#EB77BE',
'#FF9796',
'#AAC6E5',
'#8BDE90',
'#FDB5D0'
],
...
|
| disabledSections | It allows to remove sections shown in the End View in the upper part of the screen. The list of all available sections:
|
Documentation | This section allows to set links to various documentation for SAYMON. documentation: {
main: {
root: 'https://wiki.saymon.info/display/SAYMONEN',
ru: 'https://wiki.saymon.info/display/SAYMONRU'
},
notificationTemplates: {
root: 'https://wiki.saymon.info/display/SAYMONEN/Notification+templates',
ru: 'https://wiki.saymon.info/display/SAYMONRU/Notification+templates'
}
},
...
|
documentation.main | Links to user documentation. |
| documentation.main.root | Link to English-language documentation. |
| documentation.main.ru | Link to Russian-language documentation. |
documentation. | Links to notification templates. |
| documentation. notificationTemplates.root | Links to English-language notification templates. |
| documentation. notificationTemplates.ru | Links to Russian-language notification templates. |
| enableConditionalIncidents | It enables incidents functionality;
By default false | functionality is disabled. |
| enableSmsTrigger | It enables SMS-notifications;
By default false | SMS-notifications are disabled. |
| enableSnmpTranslate | It enables translation of numeric SNMP OIDs to the text format;
By default false | translation is disabled. |
| enableVoiceCallTrigger | It enables voice notifications;
By default false | voice notifications are disabled. |
ForceEmptyStandardView | By default, when an object is selected, SAYMON shows its End view, even if the object does not contain other objects. The list of class IDs, for which SAYMON will display the Standard view if the selected object is empty, can be set in this parameter. By default:
|
GeoMap
| SAYMON allows to link objects to their geographical location and browsing them on a map. geoMap: {
serverName: undefined,
initialPosition: [30.341306, 59.930089],
initialZoom: 8
},
...
|
| geoMap.initialPosition | Initial position on the map [longitude, latitude]. By default Russia, Saint Petersburg. |
| geoMap.initialZoom | Initial zoom of the map. By default 8. |
| geoMap.serverName | Name of the server used for displaying the map. By default openstreetmap.org. It is also possible to use a local OSM server. |
Grid | This section allows to set a grid for objects alignment in the Standard view. grid: {
dim: 20,
color: "rgba(128, 128, 128, 0.3)",
border: 4
},
...
|
| grid.border | Maximum indent between objects and grid border (in pixels). By default 4. |
| grid.color | Grid color in the RGBA format. Be default "rgba(128, 128, 128, 0.3)". |
| grid.dim | Grid size (in pixels). By default 20. |
GridView
| This section contains parameters of displaying objects in the Grid view. |
| gridView.cols | Amount of objects placed in one row of the grid. With gridView.cols > 0 width of objects changes automatically. With gridView.cols = 0 the number of objects in a row adjusts to the screen width. By default 6. |
| gridView.colWidth | Width of objects with gridView.cols = 0 (in pixels). |
| gridView.gutterSize | Indent between objects (in pixels). By default 5. |
| gridView.rowHeight | Height of objects (in pixels). By default 90. |
hideConnectionStatusNotifications | It hides notifications about connection status with the Comet server;
By default false | notifications about connection status with the Comet server are displayed in the web interface. |
| hideResponseErrorNotifications | It hides notifications about errors which can take place with sending automatic requests to the server;
By default false | notifications are displayed in the web interface. The errors which take place with the participation of the user, for instance, saving any data in forms, will be displayed in the web interface in any case. |
History | This section contains parameters for displayng data on graphs, also some additional interface elements, used for plotting, can be activated here. history: {
slider: false,
downsampling: [
[[1, 'hours'], '15s-avg'],
[[1, 'days'], '5m-avg'],
[[1, 'weeks'], '1h-avg'],
['1d-avg']
],
modelChangeAnnotations: false
},
...
|
| history.downsampling | Downsampling parameters. |
| history.modelChangeAnnotations | It activates the option which allows to change annotations on graphs;
By default false | annotation changing is disabled. |
| history.slider | It activates the slider, which is used for setting time range of data displaying;
By default false | slider is deactivated. |
Languages | This section allows to control installed languages of web interface. languages: {
en: { short: 'us', long: 'English' },
ru: { short: 'ru', long: 'Русский' },
it: { short: 'it', long: 'Italiano' }
},
...
|
| languages.<id> | Language identifier. Web interface is available on three languages:
|
| languages.<id>.long | Language full name. This name is displayed in SAYMON current user menu with selecting an interface language. |
| languages.<id>.short | Identifier of the flag icon. This icon displayed in SAYMON current user menu with selecting an interface language.
|
| millisecondMonitoring | It enables data update every millisecond.
By default false | update is disabled. |
Monitoring | This section contains parameters to hide unused monitoring probes from the interface. monitoring: {
standardTasks: ['ping', 'snmpGet']
},
...
|
| monitoring.standardTasks | The array of identifiers of the displayed standard probes. |
| pollInterval | Time period between data requests from the REST server, if the connection between the client and the Comet server is unavailable (in milliseconds). By default 5000 | 5 seconds. |
| pollIntervalSocket | Time period between data requests from the Comet server, if the connection between the client and the Comet server is available (in milliseconds). By default 60000 | 1 minute. |
title | Header for tabs, and also the name, displayed at the top left corner of web interface. By default SAYMON. |
Tree | This section contains parameters for object tree. tree: {
filterSubmit: true
},
...
|
| tree.filterSubmit | It enables the "apply filter" button and disables the automatic filtering;
By default false | the button is disabled. |
themes | This parameter is used to configure SAYMON themes. The theme Light is used by default. There is also the available theme Dark. CSS files with the themes are located in the directory $SAYMON_ROOT/target/client/css. $SAYMON_ROOT/target/client/css is the directory where SAYMON is installed. themes: {
default: { name: 'Light' },
dark: { name: 'Dark' }
},
...
|
useNaturalSort | It enables sorting objects with the javascript-natural-sort library:
By default false | objects are sorted with native functions of the browser. With set useNaturalSort = true performance of the web interface can degrade if there is huge number of objects in the system (100 000 and more). |
