Конфигурация Web-приложения сервера
Параметры конфигурации web-приложения сервера Центрального пульта хранятся в конфигурационном файле /etc/saymon/saymon-client.yaml
.
Файлы с параметрами конфигурации web-приложения также могут храниться в следующих файлах (в порядке снижения приоритета):
Файл конфигурации с низким приоритетом используется в том случае, если отсутствует файл конфигурации с высоким приоритетом. |
Ниже приводится описание параметров конфигурации, которые хранятся в файле saymon-client.yaml
.
Authentication
В этой секции можно настроить параметры аутентификации пользователей.
authentication:
availableMethods:
- native
- keycloak
methodByDefault: keycloak
services:
keycloak:
configUri: keycloak_frontend.json
legacySupport: false
Раздел/Параметр | Описание |
---|---|
authentication.availableMethods |
Cписок доступных методов аутентификации:
По умолчанию - native. |
authentication.methodByDefault |
Метод аутентификации, который используется по умолчанию. По умолчанию - native. |
Authentication.services
Секция с настройками сервисов аутентификации.
Раздел/Параметр | Описание |
---|---|
Authentication.services.keycloak |
Секция с настройками аутентификации через реквизиты учетной записи в Keycloak. |
authentication.services.keycloak. |
Имя файла настроек соединения, сгенерированного Keycloak-сервером для web-приложения. Файл настроек соединения необходимо разместить на сервере Центрального Пульта в каталоге |
authentication.services.keycloak. |
Включает поддержку работы с Keycloak-сервером версии ниже 19;
По умолчанию - false (работа с Keycloak-сервером версии ниже 19 не поддерживается). |
Comet
Секция с настройками взаимодействия web-приложения с сервером Центрального Пульта через comet-сервер.
comet:
port: 8091
url:
- "https://cpult.ru/ws"
- "http://10.78.5.11:8092"
Раздел/Параметр | Описание | ||
---|---|---|---|
comet.port |
Номер порта, по которому web-приложение подключается к Comet-серверу. По умолчанию используется порт 8091. |
||
comet.url |
Адреса для подключения web-приложения к comet-серверу из разных сетей. При задании адреса можно использовать IP-адрес, доменное имя или имя хоста. Также дополнительно можно указывать порт. Если задано несколько адресов, то при установке подключения осуществляется их перебор.
|
DefaultClassImage
Позволяет задать стандартное изображение и его размер для объектов определенного класса.
defaultClassImage:
"29":
img: /images/cloud.svg
dim:
- 100
- 75
DefaultEmbeddableLink
Позволяет встраивать виджеты с информацией об объектах на сторонние ресурсы.
defaultEmbeddableLink:
url: http://saymon.info/
name: SAYMON
Раздел/Параметр | Описание |
---|---|
defaultEmbeddableLink.name |
Имя виджета. |
defaultEmbeddableLink.url |
URL, на который ведёт виджет. |
Documentation
В этом разделе можно настроить ссылки на различную документацию для Центрального Пульта.
documentation: {
main: {
root: 'https://docs.saymon.tech',
ru: 'https://docs.cpult.ru
},
notificationTemplates: {
root: 'https://docs.saymon.tech/web-interface/system-configuration-window/notification-templates.html',
ru: 'https://docs.cpult.ru/web-interface/system-configuration-window/notification-templates.html'
}
},
...
Documentation.main
Ссылки на пользовательскую документацию.
Раздел/Параметр | Описание |
---|---|
documentation.main.root |
Ссылка на англоязычную документацию. |
documentation.main.ru |
Ссылка на русскоязычную документацию. |
GeoMap
Центральный Пульт позволяет привязывать объекты к их геоположению и просматривать их на карте.
geoMap:
serverName: openstreetmap.org
initialPosition:
- 30.341306
- 59.930089
initialZoom: 8
Раздел/Параметр | Описание |
---|---|
geoMap.initialPosition |
Начальная позиция на карте в формате [долгота, широта]. По умолчанию - Россия, Санкт-Петербург. |
geoMap.initialZoom |
Начальный масштаб карты. По умолчанию - 8. |
geoMap.serverName |
Имя сервера, отвечающего за отображения карты. По умолчанию - link:https://www.openstreetmap.org/openstreetmap.org. Также можно использовать локальный OSM-сервер. |
Grid
В разделе задаются настройки сетки для выравнивания объектов в стандартном виде.
grid:
dim: 20
color: rgba(128, 128, 128, 0.3)
border: 4
Раздел/Параметр | Описание |
---|---|
grid.border |
Максимальное значение отступа границы объекта от границы сетки (в пикселях). По умолчанию - 4. |
grid.color |
Цвет сетки в формате RGBA. По умолчанию - rgba(128, 128, 128, 0.3). |
grid.dim |
Размер сетки (в пикселях). По умолчанию - 20. |
GridView
В разделе задаются параметры отображения объектов в виде сетки.
gridView:
cols: 6
colWidth: 240
rowHeight: 90
gutterSize: 5
Раздел/Параметр | Описание |
---|---|
gridView.cols |
Количество объектов в строке сетки. При gridView.cols > 0 ширина объектов меняется автоматически. При gridView.cols = 0 число объектов в строке сетки подстраивается под ширину экрана. По умолчанию - 6. |
gridView.colWidth |
Ширина объектов при gridView.cols = 0 (в пикселях). По умолчанию - 240. |
gridView.gutterSize |
Величина отступа между объектами (в пикселях). По умолчанию - 5. |
gridView.rowHeight |
Высота объектов (в пикселях). По умолчанию - 90. |
History
В этом разделе задаются параметры, отвечающие за отображение данных на графиках, а также активируются некоторые дополнительные элементы интерфейса.
history:
slider: false,
downsampling:
- period: 1-hours
dsp: 15s-avg
- period: 1-days
dsp: 5m-avg
- period: 1-weeks
dsp: 1h-avg
- dsp: 1d-avg
modelChangeAnnotations: false
Раздел/Параметр | Описание |
---|---|
history.downsampling |
Параметры уменьшения размера выборки данных - downsampling. |
history.modelChangeAnnotations |
Включает смену аннотаций на графиках;
По умолчанию - false - смена аннотаций выключена. |
history.slider |
Включает ползунок, который используется для задания интервала времени отображения данных;
По умолчанию - false - ползунок выключен. |
Incidents
В этом разделе настраиваются дополнительные поля для списков активных аварий и исторических аварий.
incidents:
additionalFields:
- properties.address,
additionalFieldNames:
- IP-address
Раздел/Параметр | Описание |
---|---|
incidents.additionalFieldNames |
Имена дополнительных полей, отображаемые в интерфейсе. |
incidents.additionalFields |
Источники данных для дополнительных полей. |
Languages
Раздел позволяет управлять предустановленными языками интерфейса web-приложения.
languages:
en:
short: us
long: English
ru:
short: ru
long: Русский
it:
short: it
long: Italiano
Languages.<id>
Идентификатор языка.
Доступны три языка:
-
en - английский,
-
it - итальянский,
-
ru - русский.
Раздел/Параметр | Описание |
---|---|
languages.<id>.long |
Полное название языка. Это название отображается в меню текущего пользователя Центрального Пульта при выборе языка интерфейса. |
languages.<id>.short |
Идентификатор иконки флага. Иконка отображается в меню текущего пользователя Центрального Пульта при выборе языка интерфейса.
|
Monitoring
В этом разделе настраивается скрытие стандартных мониторинговых сенсоров из интерфейса.
monitoring:
standardTasks:
- ping
- snmpGet
Раздел/Параметр | Описание |
---|---|
monitoring.standardTasks |
Массив идентификаторов отображаемых стандартных сенсоров. |
Tree
В этом разделе задаются настройки для дерева объектов.
tree:
filterSubmit: true
Раздел/Параметр | Описание |
---|---|
tree.filterSubmit |
Включает кнопку применения фильтра и отключает его автоматическое применение при вводе символов;
По умолчанию - false - кнопка выключена. |
Прочие параметры
Раздел/Параметр | Описание | ||
---|---|---|---|
agentInstallerUrl |
Ссылка для скачивания установочного скрипта для агента. |
||
authEnabled |
Включает самостоятельную регистрацию для пользователей;
По умолчанию - false - регистрация выключена. |
||
canEditObjectStyle |
|||
collapseSections |
|||
defaultPieChartColors |
Цвета секторов по умолчанию для круговой диаграммы.
|
||
disabledSections |
Позволяет удалить секции, которые показываются при подробном отображении объекта в верхней части экрана. Список всех доступных секций:
|
||
enableAnalytics |
Включает функционал модуля аналитики;
По умолчанию - false - функционал выключен. |
||
enableConditionalIncidents |
Включает функционал генерации аварий;
По умолчанию - false - функционал выключен. |
||
enableSmsTrigger |
Включает использование SMS-уведомлений;
По умолчанию - false - SMS-уведомления выключены. |
||
enableSnmpTranslate |
Включает трансляцию SNMP OID в текстовый формат;
По умолчанию - false - трансляция выключена. |
||
enableVoiceCallTrigger |
Включает использование голосовых вызовов;
По умолчанию - false - голосовые вызовы выключены. |
||
ForceEmptyStandardView |
При выборе объекта, в том числе не содержащего вложенных объектов, Центральный Пульт по умолчанию показывает для него подробную информацию. В параметре задаётся список идентификаторов классов, при выборе пустых объектов которых Центральный Пульт переходит в стандартный вид. По умолчанию:
|
||
hideConnectionStatusNotifications |
Скрывает оповещения о статусе соединения с Comet-сервером;
По умолчанию - false - оповещения о статусе соединения с Comet-сервером выводятся в web-интерфейс. |
||
hideResponseErrorNotifications |
Скрывает оповещения об ошибках, возникающих при отправке автоматических запросов на сервер;
По умолчанию - false - оповещения выводятся в web-интерфейс.
|
||
millisecondMonitoring |
Включает обновление данных каждую миллисекунду;
По умолчанию - false - обновление выключено. |
||
pollInterval |
Интервал между запросами данных с REST-сервера, если соединение между клиентом и Comet-сервером недоступно (в миллисекундах). По умолчанию - 5000 - 5 секунд. |
||
pollIntervalSocket |
Интервал между запросами данных с Comet-сервера, если соединение между клиентом и Comet-сервером доступно (в миллисекундах). По умолчанию - 60000 - 1 минута. |
||
Отображать кнопку "Показать историю данных".
По умолчанию – false |
|||
title |
Заголовок для вкладок, а также имя, отображаемое в левом верхнем углу web-интерфейса. По умолчанию - SAYMON. |
||
themes |
Этот параметр отвечает за настройку тем. По умолчанию используется тема Light. Также доступна тема Dark. CSS-файлы с темами находятся в директории
|
||
useNaturalSort |
Включает сортировку объектов с помощью библиотеки javascript-natural-sort:
По умолчанию - false - объекты сортируются с помощью нативных функций браузера.
|