Avanpost FAM/MFA+ : 4.3.7. Установка Avanpost FAM Self Service в ОС Windows

Загрузка дистрибутива

Перед установкой следует загрузить дистрибутив компонента Avanpost FAM Self Service, представляющий собой zip-архив, содержащий:

  • установочный исполняемый файл формата *.exe;
  • конфигурационные файлы config.selfservice.sample в форматах *.json и *.toml;
  • конфигурационный файл config.selfservice.nats.sample.json;
  • директорию public, содержащую публичные ресурсы (статические файлы и шаблоны), необходимые при установке и настройке.

Установка приложения на сервере под управлением Windows ОС

Установка и настройка компонента на сервере под управлением ОС Windows осуществляется в следующей последовательности:

  1. Распаковать скачанный дистрибутив в формате zip-архива в любой каталог на сервере.
  2. Настроить параметры NATS-сервера в конфигурационном файле config.selfservice.nats.sample.json
  3. Настроить параметры FAM Self Service в конфигурационном файле config.selfservice.nats.sample.json.
  4. Запустить исполняемый exe-файл согласно данной инструкции.

Приложение A. Параметры конфигурационного файла NATS-сервера config.selfservice.nats.sample.json

ПараметрОписание
port

Порт для установки соединения клиента с NATS-сервером.

По умолчанию: 4222

addrIP-адрес NATS-сервера

В конфигурационном файле NATS-сервера допускается настройка дополнительных параметров согласно документации https://docs.nats.io/running-a-nats-service/configuration.

Приложение B. Параметры конфигурационного файла FAM Self Service config.selfservice.sample.json

ПараметрОписание
cert

Путь к сертификату, используемому в продукте. Токены, верифицируемые Avanpost Self Service в процессе работы компонента подписываются данным сертификатом.

public_dirПуть к директории public, где располагаются публичные ресурсы (статические файлы и шаблоны), необходимые для установки и настройки компонента.
[templates]
templates

Путь к директории с шаблонами по умолчанию.

localization

Путь к директории с шаблонами локализации.   

saml_response

Путь к шаблону ответа SAML.

oauth2_form_post_templateПуть к шаблону формы ответа OAuth2 для метода POST.
oauth2_error_templateПуть к шаблону ошибки OAuth2.
[lk]
issuer

Идентификатор системы (автора токена) при выдаче токенов подтверждения личности. По умолчанию: devenv.avanpost.ru

baseUrlБазовый URL компонента. По умолчанию: http://localhost:4009
authority

Параметр, настраивающий способ авторизации пользователя:

  • Базовый URL Avanpost FAM Self Service (значение параметра: baseUrl данного конфигурационного файла) -  Avanpost Self Service выступает сервером авторизации и проксирует запросы авторизации в FAM Server через NATS-сервер.
  • Базовый URL Avanpost FAM Server (значение параметра: baseUrl конфигурационного файла Avanpost FAM Server) - Avanpost Self Service перенаправляет пользователя на Avanpost FAM Server, где пользователь авторизуется и затем перенаправляется обратно в Self Service

По умолчанию: http://localhost:4008

portПорт, на котором работает Avanpost FAM Self Service. По умолчанию: 4009
pathПуть к Avanpost FAM Self Service (если он поднят не в корневом каталоге хоста).
idleTimeoutInMinutes

Промежуток времени бездействия (в минутах), после которого пользователь будет отключен от личного кабинета (допускается не настраивать параметр, если он настроен для Avanpost FAM Service). По умолчанию: 50

dirПуть к директории, в которой содержится файлы для SPA-приложения.
clientIdИмя клиента, по которому происходит авторизация на FAM Server.
natsTimeoutSecПромежуток времени (в секундах) на ответ от NATS-сервера. 
[nats]
connection

Параметр, по которому можно указать адрес хоста NATS-сервера, для которого выпущен сертификат.

embedded

Параметр, позволяющий задать тип NATS-сервера:

  • true - используется встроенный NATS-сервер;
  • false - используется внешний NATS-сервер.

По умолчанию в конфигурационном файле: true

serverCfgFileПуть к конфигурационному файлу NATS-сервера.
useTls

Параметр, позволяющий использовать защищенное TLS-соединение:

  • true - TLS-соединение используется;
  • false - TLS-соединение используется.
caCertPathПуть к сертификату NATS-сервера.
certPathПуть к ключам NATS-сервера.
keyPathПуть к ключу клиента для подключения к NATS-серверу.
clientCertPathПуть к сертификату клиента для подключения к NATS-серверу.
usernameЛогин клиента, подключающегося к NATS-серверу.
passwordПароль клиента, подключающегося к NATS-серверу.
tokenТокен клиента, подключающегося к NATS-серверу (токен используется как разделяемый между Avanpost FAM SelfService и Avanpost FAM Server).
[cluster]
enabled

Параметр, позволяющий организовать настроенные экземпляры Avanpost FAM в кластер «клиентской» балансировки:

  • true - организовывать в кластер;
  • false - не организовывать в кластер.

Если включена организация нод в кластер, требуется указать идентификаторы главного и прочих узлов FAM.

По умолчанию в конфигурационном файле: true

[cluster.self]
idУникальный идентификатор главного узла FAM Server. 
[cluster.nodes]
idИдентификаторы прочих нод Avanpost FAM, который будут предоставлять информацию главному узлу. 


Обсуждение