Утилита ConfigureService выполняет конфигурирование компонентов JWM – сервисов ЛК (сервиса данных и аутентификации) и порталов (внутреннего и внешнего).

Утилита располагается в каталогах соответствующих сервисов

Ниже приведен полный перечень команд, параметров и ключей утилиты ConfigureService.

Команда authservice

Настройки сервиса аутентификации (применяется только к инстансу сервисов, локация DataService).

Параметр

Описание

install endpoint

Задать адрес, по которому приложение будет принимать запросы на аутентификацию

Ключи:

·   -u, --url  (обязательный) – Адрес, по которому приложение будет принимать запросы на аутентификацию.

Пример команды:

/opt/jms-web-manager/DataService/Configurator/ConfigureService authservice install endpoint -u https://localhost:5702

Пример выдачи: 

install cert

Установить сертификат для подключения по SSL. Значения записываются в конфигурационный файл. Сертификат и пароль не проверяются на валидность.

Ключи:

·   -d, --path (обязательный) - Полный путь к сертификату

·   -p, --password (необязательный) - Пароль от контейнера сертификата. По умолчанию - пустой

·   -i, --invalid (необязательный) - Указывает, следует ли учитывать недействительные сертификаты, например, самоподписанные сертификаты. По умолчанию false

Примеры команды: 

/opt/jms-web-manager/DataService/Configurator/ConfigureService authservice install cert -d "~/cert/cert_jwm1.pfx" -p "P@ssw0rd"
/opt/jms-web-manager/DataService/Configurator/ConfigureService authservice install cert -d "~/cert/cert_jwm1.pfx"

Примеры выдачи:

show endpoint

Показать адрес по которому приложение будет принимать запросы.

Пример команды:

/opt/jms-web-manager/DataService/Configurator/ConfigureService authservice show endpoint

Пример выдачи:

show cert

Показать информацию о сертификате, используемому при https-подключении. Если сертификат не установлен, отображается пустая строка.

Пример команды:

/opt/jms-web-manager/DataService/Configurator/ConfigureService authservice show cert

Пример выдачи:

Команда cors

Управление исключениями CORS

Параметр

Описание

add

Добавить адрес в исключения CORS.

Ключи:

·   -u, --url (обязательный) -- Список CORS адресов, в двойных кавычках. В случае нескольких адресов, их указывают через запятую без пробела.

Примеры команды:

/opt/jms-web-manager/UserPlace/Configurator/ConfigureService cors add -u "http://test.astra.ipa:5600"
/opt/jms-web-manager/UserPlace/Configurator/ConfigureService cors add --url "http://test.astra.ipa:5600,http://test3.astra.ipa:5600"

remove

Удалить адрес из списка CORS-адресов.

Ключи:

·   -u, --url (обязательный) -- Адрес для удаления из списка CORS.

Пример команды:

/opt/jms-web-manager/UserPlace/Configurator/ConfigureService cors remove -u http://test.astra.ipa:5600


Команда dataservice

Настройки сервиса данных (применяется только к инстансу сервисов, локация DataService).

Параметр

Описание

install endpoint

Задать адрес, по которому приложение будет принимать запросы.

Ключи:

·   -u, --url  (обязательный) – Адрес, по которому приложение будет принимать запросы.

Пример команды:

/opt/jms-web-manager/DataService/Configurator/ConfigureService dataservice install endpoint -u https://localhost:5701

Пример выдачи: 

install cert

Установить сертификат для подключения по SSL. Значения записываются в конфигурационный файл. Сертификат и пароль не проверяются на валидность.

Ключи:

·   -d, --path (обязательный) - Полный путь к сертификату

·   -p, --password (необязательный) - Пароль от контейнера сертификата. По умолчанию - пустой

·   -i, --invalid (необязательный) - Указывает, следует ли учитывать недействительные сертификаты, например, самоподписанные сертификаты. По умолчанию false

Примеры команды:

/opt/jms-web-manager/DataService/Configurator/ConfigureService dataservice install cert -d "~/cert/cert_jwm1.pfx" -p "P@ssw0rd"
/opt/jms-web-manager/DataService/Configurator/ConfigureService dataservice install cert -d "~/cert/cert_jwm1.pfx"

Примеры выдачи: 

show endpoint

Показать адрес по которому приложение будет принимать запросы.

Пример команды:

/opt/jms-web-manager/DataService/Configurator/ConfigureService dataservice show endpoint

Пример выдачи:

show cert

Показать информацию о сертификате, используемому при https-подключении. Если сертификат не установлен, отображается пустая строка.

Пример команды:

/opt/jms-web-manager/DataService/Configurator/ConfigureService dataservice show cert

Пример выдачи:

Команда db

Управление исключениями CORS

Параметр

Описание

install

Установить настройки подключения к БД JWM.

Ключи:

·   -c, --conection  (обязательный) - Строка подключения к БД, в двойных кавычках 

·   -p, --provider  (обязательный) - Провайдер БД, в двойных кавычках

Пример команды:

/opt/jms-web-manager/DataService/Configurator/ConfigureService db install -c "Host=10.0.24.114;Port=5432;Username=postgres;Password=P@ssw0rd;Database=JWMDB" -p "PostgreSQL"

Пример выдачи: 

show

Показать настройки подключения к БД JWM.

Пример команды:

/opt/jms-web-manager/DataService/Configurator/ConfigureService db show

 

Команда help

Получение справки по ConfigureService

Пример команды:

/opt/jms-web-manager/UserPlace/Configurator/ConfigureService help

Команда init

Инициализация сервиса данных JWM и портала пользователя.

Ключи:  

  • -p, --path (обязательный) - Полный путь к файлу инициализации *.ini.

Пример команды для портала:

/opt/jms-web-manager/UserPlace/Configurator/ConfigureService init -p /opt/conf/JWMini4.ini

Пример команды для сервиса данных и аутентификации: 

/opt/jms-web-manager/DataService/Configurator/ConfigureService init -p /opt/conf/JWMini4.ini

Команда jas

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

Параметр

Описание

install

Установить настройки подключения к серверу JAS (применяется только к службе данных  DataService).

Ключи:

·   -u, --url  (обязательный) - Установить адрес подключения к JAS

Пример команды:

/opt/jms-web-manager/DataService/Configurator/ConfigureService jas install -u http://localhost:8221/api/v4.1

Пример выдачи: 

show

Показать настройки подключения к серверу JAS (применяется только к службе данных  DataService).

Пример команды:

/opt/jms-web-manager/DataService/Configurator/ConfigureService jas show

Пример выдачи:

Команда jms

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

Параметр

Описание

install

Установить настройки подключения к серверу JMS (применяется только к службе данных  DataService).

Ключи:

·   -a, --auth  (обязательный) - установить адрес сервера аутентификации JMS

·   -c, --client  (необязательный) - установить адрес сервера данных JMS. По молчанию не записывается/не перезаписывается в конфигурационный файл

·   -u, --user  (необязательный) - Полное имя пользователя JMS. Если параметр не указан, то будет запрошен во время выполнения команды

Пример команды:

/opt/jms-web-manager/DataService/Configurator/ConfigureService jms install -a http://localhost:8121 -c http://localhost:8120 -u astra.ipa\\admin

Пример выдачи: 

show

Показать настройки подключения к серверу JMS (применяется только к службе данных  DataService).

Пример команды:

/opt/jms-web-manager/DataService/Configurator/ConfigureService jms show

Пример выдачи:

Команда jwa

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

Параметр

Описание

install http

(install https)

Установить адрес для подключения к JWA (применяется только порталам, UserPlace).

install http – для подключения по http

install https – для подключения по ssl

Ключи:

·   -u, --url  (обязательный) - Установить адрес для запросов к JWA

Примеры команды:

/opt/jms-web-manager/UserPlace/Configurator/ConfigureService jwa install https -u https://localhost:5600
/opt/jms-web-manager/UserPlace/Configurator/ConfigureService jwa install http -u http://localhost:5601

Пример выдачи:

show http

(show https)

Показать адрес для подключения к порталу из web-клиента (применяется только порталам, UserPlace).

show http – при подключении по http

show https – при подключении по ssl

Примеры команды:

/opt/jms-web-manager/UserPlace/Configurator/ConfigureService jwa show http
/opt/jms-web-manager/UserPlace/Configurator/ConfigureService jwa show https

Пример выдачи:

Команда jwm

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

Параметр

Описание

install

Установить настройки портала пользователя  (применяется только к службе портала, UserPlace)..

Ключи:

·   -m, --mode  (обязательный) - Режим работы портала пользователя. Допустимые значения:

–   Private

–   Public

·   -p,  --PathBase  (необязательный) - Базовый путь по которому будет доступен портал пользователя. По молчанию не записывается / не перезаписывается в конфигурационный файл

Пример команды:

/opt/jms-web-manager/UserPlace/Configurator/ConfigureService jwm install -m Private -p /JMS/private

Пример выдачи: 

show

Показать настройки портала пользователя (применяется только к службе портала, UserPlace).

Пример команды:

/opt/jms-web-manager/UserPlace/Configurator/ConfigureService jwm show

Пример выдачи:

Команда jwt

Работа с сертификатами jwt (применяется ко всем сервисам, локации DataService и UserPlace).

Параметр

Описание

install cert

Установить сертификат для подписи jwt-токенов.

Ключи:

·   -t, --ttl (необязательный) - Время жизни jwt-токена в минутах. По умолчанию 15 минут

·   -s, --thumbprint (необязательный) - Задать отпечаток сертификата

·   -d, --path (обязательный) - Путь к *.pfx файлу сертификата. Если указан отпечаток, то путь – пустой.

Важно! При установке сертификата указывается либо путь (path), либо отпечаток (thumbprint); при этом, если указан ключ thumbprint, то в ключе path  следует указать пустое значение:  --path ""  или  -d "".

·   -p, --password (обязательный при указании path) - Пароль от контейнера сертификата

·   -c, --clock (необязательный) - Получает или задает сдвиг часов, который будет применяться при проверке времени во время валидации JWT. По умолчанию 60 секунд

·   -n, --novalidate (необязательный) - Указывает, следует ли учитывать недействительные сертификаты, например самоподписанные сертификаты.  По умолчанию false

Примеры команды:

/opt/jms-web-manager/DataService/Configurator/ConfigureService jwt install cert -s "6EDF2C568B02352D938EE2D907743913E4890C5B" -d ""
/opt/jms-web-manager/UserPlace/Configurator/ConfigureService jwt install cert -s "6EDF2C568B02352D938EE2D907743913E4890C5B" -d ""

Пример выдачи:

show flags

Показать информацию о флагах верификации сертификата.

Примеры команды:

/opt/jms-web-manager/DataService/Configurator/ConfigureService jwt show flags
/opt/jms-web-manager/UserPlace/Configurator/ConfigureService jwt show flags

Примеры выдачи:

show cert

Показать информацию о сертификате. Если сертификат не установлен, отображается пустая строка

Примеры команды:

/opt/jms-web-manager/DataService/Configurator/ConfigureService jwt show cert
/opt/jms-web-manager/UserPlace/Configurator/ConfigureService jwt show cert

Примеры выдачи:

set cert_flags

Установить сертификат для подписи jwt-токенов.

Ключи:

·   - v, --verification (необязательный) - Флаги верификации для сертификата. Возможные значения приведены по ссылке: https://learn.microsoft.com/ru-ru/dotnet/api/system.security.cryptography.x509certificates.x509verificationflags?view=net-7.0

 по умолчанию не записывается в конфигурационный файл

·   - r, --revocation (необязательный) - Режим для проверки отзыва сертификата. Допустимые значения приведены по ссылке: https://learn.microsoft.com/ru-ru/dotnet/api/system.security.cryptography.x509certificates.x509revocationmode?view=net-7.0

по умолчанию не записывается в конфигурационный  файл

·   -t, --ttl (обязательный) - Время жизни jwt токена в минутах. (Типовое значение 15)

Примеры команды:

/opt/jms-web-manager/DataService/Configurator/ConfigureService jwt set cert_flags -t 15
/opt/jms-web-manager/UserPlace/Configurator/ConfigureService jwt set cert_flags -t 15

Пример выдачи:

remove cert

Удалить установленный сертификат.

Важно! Сертификат удаляется из хранилища сертификатов

Примеры команды:

/opt/jms-web-manager/DataService/Configurator/ConfigureService jwt remove cert
/opt/jms-web-manager/UserPlace/Configurator/ConfigureService jwt remove cert

Команда userplace

Настройки портала пользователя (применяется только к инстансу портала, локация UserPlace).

Параметр

Описание

show

Показать настройки портала пользователя.

·   show endpoint - Показать адрес по которому приложение будет принимать запросы;

·   show cert - Показать информацию о сертификате, используемому при https подключении, если его нет – пустая строка;

·   show dataservice – Показать настройки подключения к сервису данных;

·   show authservice - Показать настройки подключения к сервису аутентификации;

·   show captcha - Показать настройки поля «капча» (captcha) портала пользователя.

Примеры команд:

/opt/jms-web-manager/UserPlace/Configurator/ConfigureService userplace show cert
/opt/jms-web-manager/UserPlace/Configurator/ConfigureService userplace show endpoint
/opt/jms-web-manager/UserPlace/Configurator/ConfigureService userplace show authservice
/opt/jms-web-manager/UserPlace/Configurator/ConfigureService userplace show dataservice
/opt/jms-web-manager/UserPlace/Configurator/ConfigureService userplace show captcha

Примеры выдачи:

Примеры выдачи userplace show captcha:

install captcha

Настроить параметры поля «капча» (captcha).

Ключи:

·   -d, --DrawBeziersCount  (обязательный) - количество кривых Безье,  целое число от  0 до 2

·   -t, --BezierThickness1  (необязательный) - толщина первой кривой Безье,  целое  число от  0 до 10

·   -f, --BezierThickness2  (необязательный) - толщина второй кривой Безье,  целое число от  0 до 10;

·   -p, --Pixelate (необязательный) – пикселирование, целое число от  0 до 10;

·   -g, --GaussianBlur  (необязательный) - величина гауссовского размытия, дробное число от 0 до 10, десятые доли отделяются запятой;

·   -s, --SkewX  (необязательный) - перекос по Х, целое  число от  -180 до 180

При отсутствии необязательного параметра сохраняется текущее значение параметра в конфигурационном файле (см. пример выдачи команды userplace show captcha, выше)

Примеры команды:

/opt/jms-web-manager/UserPlace/Configurator/ConfigureService userplace install captcha -d 1 -g 1.3

Примеры выдачи:

install cert

Установить сертификат для подключения по SSL.

Ключи:

·   -d, --path (обязательный) - Полный путь к сертификату

·   -p, --password (необязательный) - Пароль от контейнера сертификата. По умолчанию - пустой

·   -i, --invalid (необязательный) - Указывает, следует ли учитывать недействительные сертификаты, например, самоподписанные сертификаты. По умолчанию false

Примеры команды:

/opt/jms-web-manager/UserPlace/Configurator/ConfigureService userplace install cert -d "/opt/cert/cert1.pfx" -p "P@ssw0rd"

Примеры выдачи: 

install endpoint

Задать адрес, по которому приложение будет принимать запросы.

Ключи:

·   -u, --url  (обязательный) – Адрес, по которому приложение будет принимать запросы.

Пример команды:

/opt/jms-web-manager/UserPlace/Configurator/ConfigureService userplace install endpoint -u https://localhost:5700

Пример выдачи: 

install dataservice

Установка параметров доступа к сервису данных

Ключи:

·   -u, --url  (обязательный) – Адрес для доступа к сервису данных.

·   -t, --timeout  (необязательный) - Время ожидания ответа от сервиса данных в секундах. Значение по умолчанию: 15

·   -p, --useproxy  (необязательный) - Флаг использования прокси для соединения с сервисом данных. Значение по умолчанию: false

Пример команды:

/opt/jms-web-manager/ UserPlace /Configurator/ConfigureService userplace install dataservice -u "https://localhost:5701" -t 15

Пример выдачи: 

install authservice

Установка параметров доступа к сервису аутентификации

Ключи:

·   -u, --url  (обязательный) – Адрес для доступа к сервису аутентификации.

·   -t, --timeout  (необязательный) - Время ожидания ответа от сервиса аутентификации в секундах. Значение по умолчанию: 15

·   -p, --useproxy  (необязательный) - Флаг использования прокси для соединения с сервисом аутентификации. Значение по умолчанию: false

Пример команды:

/opt/jms-web-manager/UserPlace/Configurator/ConfigureService userplace install authservice -u "https://localhost:5702" -t 15

Пример выдачи: 

Команда version

Показать версию продукта

Примеры команды:

/opt/jms-web-manager/UserPlace/Configurator/ConfigureService version
/opt/jms-web-manager/DataService/Configurator/ConfigureService version

Примеры выдачи: