Перейти к содержанию

Описание свойств manifest.yml

Пример manifest.yml файла

manifest.yml
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
main:
  app: "login-center"
  version: "f-1.100.0.0"
  publicHostname: "login.optimacros.com"
initialization:
  adminUsername: "admin@optimacros.com"
  adminPassword: "pa$$W0rd"
  firstWorkspaceName: "WORKSPACE 1"
  firstWorkspaceHostname: "ws1.optimacros.com"
mongo:
  version: "4.4.21"
  dbUsername: "login-center"
  dbPassword: "data-base-p@$$W0rd"
redis:
  version: "6.2-alpine"
nginx:
  version: "1.24.0"
  workspaceProxyUrl: ""
exportService:
  allowExport: ""
nats:
  password: "N2ksa8I1oQ1y5asYNY6rWE" # пароль > 22 символов
  systemPassword: "uOL1kh3wAtRzUth6W4pR7I" # пароль > 22 символов

Описание параметров

Раздел main

Основные параметры логин центра.

  • app: "login-center" - тип дистрибутива

    Warning

    изменять нельзя

  • version: "1.34.1" - версия дистрибутива Логин Центра

    Warning

    изменять нельзя

  • publicHostname: "" - URL Логин Центра. изменяется при смене адреса Login Center.

Раздел initialization

Данные переменные используются при первом запуске логин центра и последующее их изменение никак не влияют на работу ЛЦ.

  • adminUsername: "admin@optimacros.com" - не используется после первого запуска Login Center.

    Warning

    Внимание: Это поле всегда должно быть почтовым адресом.

  • adminPassword: "pa$$W0rd" - не используется после первого запуска Login Center рекомендуется 16-20 символов.

    Warning

    Внимание в этом поле нельзя использовать символ @.

  • firstWorkspaceName: "TEST" - указывается имя первого воркспейса, который будет подключен к ЛЦ. Не используется после первого запуска Login Center.

  • firstWorkspaceHostname: "workspace1.com" - адрес первого воркспейса. Изменяется при смене адреса воркспейса.

Раздел mongo

Параметры рабочей базы данных приложения.

  • version: "4.4.21" - версия установленной в дистрибутив БД mongo.

    Warning

    изменять нельзя

  • dbUsername: "logincenter" - изменяется при смене имени пользователя MongoDB.

  • dbPassword: "logincenter" - изменяется при смене пароля MongoDB. Рекомендуется пароль 18 символов.

Раздел redis

  • version: "6.2-alpine" - версия установленной в дистрибутив БД redis.

    Warning

    изменять нельзя.

Раздел nginx

  • version: "1.24.0" - версия установленного в дистрибутив nginx.

    Warning

    изменять нельзя

  • workspaceProxyUrl: "" - используется при совместной установке воркспейса и ЛЦ на одной машине. по умолчанию пустое поле. Подробнее в инструкции по совместной установке.

Раздел exportService

  • allowExport: "" - системное поле включающее или отключающее функцию экспорта отчёта по пользователям в разделе System ЛЦ, кнопка Export Users. Принимает значения true или false. По умолчанию (если не указать ничего) принимает значение false.

Раздел audit

  • maskUserTokenInAudit: "true" - false - disabled, true - enabled (token will be truncated to the first 8 characters).

Раздел nats

  • password: "" - пароль > 22 символов - Обязательное системное поле пароля пользователя nats, минимум 22 символа.

    Warning

    Внимание: в этом поле нельзя использовать символы " ' ` \ $

  • systemPassword: "" - пароль > 22 символов - Обязательное системное поле пароля администратора nats, минимум 22 символа.

    Warning

    Внимание: в этом поле нельзя использовать символы " ' ` \ $

Раздел node

  • extraCaCerts: "" - путь к дополнительным сертификатам.

Раздел initialization

Info

Добавлено в версии Логин Центра f-1.200.x.x

  • allowUIAddUsers: true - опциональный параметр, включает или отключает возможность добавлять пользователей на воркспейс через UI ЛЦ, также блокирует создание юзера через модель WS во вкладке "Другие пользователи сервера". Оставляет возможность добавлять новых пользователей только с помощью сторонних сервисов авторизации (AD, SAML, OAuth и т.д.)

Раздел constraints

Info

Добавлено в версии Логин Центра f-1.200.x.x

  • concurrentSessionsLimit: "" - опциональный параметр. Лимит на одновременное количество сессий для одной учётной записи пользователя. 0 или не задано - нет лимита.

Раздел syslog

Info

Добавлено в версии Логин Центра f-1.200.x.x

  • enabled: "" - true or false Включает или отключает Syslog
  • messageFormat: "RFC5424" - формат сообщений RFC5424
  • eventsStoreInMinutes: "" - срок хранения сообщений на хост машине, в минутах
  • sendEverySeconds: "" - периодичность отправки сообщений в секундах
  • hostIp: "" - ip машины на которую отправляются логи (syslog-server приёмщик логов, или обработчик)
  • port: "6514" - порт, по которому ведётся подключение, конфигурируемый
  • rootCaPath: "" - путь к файлам сертификатов и ключей формата .pem
  • clientCertPath: "" - путь к клиентскому сертификату .crt
  • clientKeyPath: "" - путь к клиентскому ключу сертификата .key
  • hostId: "" - hostname машины на которую отправляются логи (syslog-server приёмщик логов, или обработчик)

Прочие параметры

  • namespace: "" - ТОЛЬКО ДЛЯ HELM ПЛАТФОРМЫ! пространство имен namespace в кластере Kubernetes для работы приложения на платформе helm. Создается автоматически инсталлятором или вручную администратором кластера.

  • nodeName: "" - ТОЛЬКО ДЛЯ HELM ПЛАТФОРМЫ! наименование рабочей ноды, к которой будут привязаны поды компонентов Логин Центра в кластере при работе на платформе helm.