Загрузка дистрибутива
Перед установкой следует загрузить дистрибутив компонента Avanpost FAM Self Service, представляющий собой zip-архив, содержащий:
- установочный исполняемый файл формата *.exe;
- конфигурационные файлы
config.selfservice.sample
в форматах *.json и *.toml; - конфигурационный файл
config.selfservice.nats.sample.json;
- директорию
public
, содержащую публичные ресурсы (статические файлы и шаблоны), необходимые при установке и настройке.
Установка приложения на сервере под управлением Windows ОС
Установка и настройка компонента на сервере под управлением ОС Windows осуществляется в следующей последовательности:
- Распаковать скачанный дистрибутив в формате zip-архива в любой каталог на сервере.
- Настроить параметры NATS-сервера в конфигурационном файле
config.selfservice.nats.sample.json
. - Настроить параметры FAM Self Service в конфигурационном файле
config.selfservice.nats.sample.json.
- Запустить исполняемый exe-файл согласно данной инструкции.
Приложение A. Параметры конфигурационного файла NATS-сервера config.selfservice.nats.sample.json
Параметр | Описание |
---|---|
port | Порт для установки соединения клиента с NATS-сервером. По умолчанию: 4222 |
addr | IP-адрес 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 | Идентификатор системы (автора токена) при выдаче токенов подтверждения личности. По умолчанию: |
baseUrl | Базовый URL компонента. По умолчанию: http://localhost:4009 |
authority | Параметр, настраивающий способ авторизации пользователя:
По умолчанию: |
port | Порт, на котором работает Avanpost FAM Self Service. По умолчанию: 4009 |
path | Путь к Avanpost FAM Self Service (если он поднят не в корневом каталоге хоста). |
idleTimeoutInMinutes | Промежуток времени бездействия (в минутах), после которого пользователь будет отключен от личного кабинета (допускается не настраивать параметр, если он настроен для Avanpost FAM Service). По умолчанию: |
dir | Путь к директории, в которой содержится файлы для SPA-приложения. |
clientId | Имя клиента, по которому происходит авторизация на FAM Server. |
natsTimeoutSec | Промежуток времени (в секундах) на ответ от NATS-сервера. |
[nats] | |
connection | Параметр, по которому можно указать адрес хоста NATS-сервера, для которого выпущен сертификат. |
embedded | Параметр, позволяющий задать тип NATS-сервера:
По умолчанию в конфигурационном файле: |
serverCfgFile | Путь к конфигурационному файлу NATS-сервера. |
useTls | Параметр, позволяющий использовать защищенное 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 в кластер «клиентской» балансировки:
Если включена организация нод в кластер, требуется указать идентификаторы главного и прочих узлов FAM. По умолчанию в конфигурационном файле: |
[cluster.self] | |
id | Уникальный идентификатор главного узла FAM Server. |
[cluster.nodes] | |
id | Идентификаторы прочих нод Avanpost FAM, который будут предоставлять информацию главному узлу. |