Настройка с использованием конфигурационного файла

Если до установки была выполнена предварительная настройка приложения, то дополнительные действия не требуются.

При необходимости изменения параметров (например, уровня логирования или параметров подключения к контроллеру домена) отредактируйте конфигурационный файл application.yml на сервере, где установлено приложение (путь к файлу — /opt/dsm/application.yml), и выполните перезапуск командой:

sudo systemctl restart dsm.service

Для успешного запуска приложения при создании или редактировании файла application.yml учитывайте следующее:

  • формат *.yml чувствителен к форматированию (см. RFC 9512), соблюдайте отступы;

  • в поле ldap.connection.password (поле является обязательным) укажите пароль в зашифрованном виде с использованием base64;

  • если используется HTTPS, то значения server.ssl.key-store-password и server.ssl.key-password также укажите в зашифрованном виде с использованием base64.

Параметры конфигурационного файла

Ниже приведены параметры файла application.yml (см. «Пример application.yml»), которые доступны для настройки приложения.

Секция server

Параметры сервера для подключения к приложению.

port

Порт для подключения к приложению.

Значение по умолчанию — port: 8080.

Настройки SSL-соединения:

В примере application.yml указаны параметры SSL-соединения, при которых приложение будет доступно только по HTTPS.
metrics_enabled

Включает мониторинг для ssl-соединения (см. секцию Prometheus в разделе «Сбор метрик приложения "Менеджер службы каталогов"»).

Доступные значения:

  • true — включает;

  • false — выключает.

key-store

Путь к хранилищу ключей, содержащему сертификат SSL.

key-store-password

Пароль в зашифрованном виде с использованием Base64, используемый для доступа к хранилищу ключей.

key-store-type

Тип хранилища ключей (JKS или PKCS12).

key-alias

Псевдоним, идентифицирующий ключ в хранилище ключей.

key-password

Пароль в зашифрованном виде с использованием Base64, используемый для доступа к ключу в хранилище ключей.

Секция logging

Параметры логирования.

В секции приведены параметры, которые установлены по умолчанию в приложение и применяются, если в application.yml не заданы другие.

Более подробно по настройке логирования см. в разделе «Логирование приложения "Менеджер службы каталогов"».
level

Устанавливает уровень логирования для приложения (формат: tech.inno.dsm: <уровень логирования>).

Доступные уровни логирования:

  • DEBUG — уровень отладочных сообщений;

  • ERROR — уровень ошибок;

  • INFO — уровень информационных сообщений;

  • OFF — логирование выключено;

  • TRACE — уровень всех сообщений;

  • WARN — уровень предупреждений.

file

В параметре name указывается название файла с логом.

logback

Библиотека для работы с логами.

Используется секция rollingpolicy с параметрами:

  • file-name-pattern — определяет название лог-файла и частоту ротации;

  • max-file-size — максимальный размер лог-файла;

  • total-size-cap — максимальный суммарный размер всех лог-файлов;

  • max-history — максимальное количество лог-файлов.

pattern

В параметре файл file задается формат сообщения для лога.

Cекция ldap

Настройки для ldap-соединения.

Настройки connection

Настройки для подключения к контроллеру домена.

host

Адрес для подключения.

port

Порт для подключения.

user

Имя технической учетной записи.

password

Пароль технической учетной записи в зашифрованном виде с использованием Base64.

responseTimeoutMillis

Тайм-аут ответа ldap-операций, в миллисекундах.

Значение по умолчанию — 120000.
base-dn

Объект каталога, начиная с которого производится поиск.

Секция domain

Параметры домена.

name

Имя домена.

Cекция gpm

Настройки admx-шаблонов.

Настройки admx

path

Путь к admx-шаблонам, содержащим описание политик.

locale

Применяемая локализация, а также название директории относительно пути к admx-шаблонам, определенным в параметре path.

target-namespace

Целевое пространство имен в случае отсутствия или различия с определенных в файлах шаблонов и локализации.

hide-empty-categories

Cкрытие категорий, не содержащих других категорий и политик.

Доступные значения:

  • true — включает;

  • false — выключает.

server-path

Путь к каталогу, где лежат файлы со значениями политик после их выбора в шаблонах.

Секция management

Параметры для подключения к актуаторам приложения.

server

IP-адрес для подключения.

port

Порт для подключения.

Пример application.yml

server:
  port: 8090
  ssl:
    metrics_enabled: true
    key-store: /opt/dsm/springboot.p12
    key-store-password: cGFzc3dvcmQx
    key-store-type: pkcs12
    key-alias: springboot
    key-password: cGFzc3dvcmQy

logging:
  level:
    tech.inno.dsm: DEBUG
  file:
    name: dsm.log
  logback:
    rollingpolicy:
      file-name-pattern: dsm_%d{yyyy-MM-dd}_archive-%i.log
      max-file-size: 10MB
      total-size-cap: 1000MB
      max-history: 365
  pattern:
    file: "%d [%thread] %-5level %-50logger{40} - %msg%n"

ldap:
  connection:
    host: 127.0.0.1
    port: 389
    user: CN=Administrator,CN=Users,DC=SAMBA,DC=LAN
    password: cGFzc3dvcmQz
    responseTimeoutMillis: 120000
  base-dn: DC=SAMBA,DC=LAN

domain:
  name: SAMBA.LAN

gpm:
  admx:
    path: /app/inno-samba/share/samba/admx
    locale: en-US
    target-namespace: http://schemas.microsoft.com/GroupPolicy/2006/07/PolicyDefinitions
  server-path: /app/inno-samba/var/locks

management:
  server:
    port: 8081