Развертывание BPMSoft .NET Framework на Microsoft Windows

Подготовка к развертыванию BPMSoft

Перед развертыванием системы необходимо выполнить следующие шаги:

• Проверка обязательных компонентов Microsoft Windows;
• Для операционной системы Microsoft Windows Server;
• Для операционной системы Microsoft Windows 10;
• Установка сервера кэширования;
• Установка СУБД и восстановление базы данных.

Проверка обязательных компонентов Microsoft Windows

Для корректной установки и работы BPMSoft требуется проверить, что установлены:

• Компонент Microsoft Visual C++ 2015-2022 Redistributable;
• Компоненты Web Server IIS.

Список обязательных компонентов и их элементов представлен в таблице ниже.

Таблица 1 — Список обязательных компонентов и их элементов

Проверка обязательных компонентов для операционной системы Microsoft Windows Server

Для корректной установки и работы BPMSoft на Microsoft Windows Server требуется проверить наличие установки обязательных компонентов и при их отсутствии установить недостающие. Для этого требуется выполнить следующие действия.

1. Откройте «Control Panel» и выберите «Turn Windows features on or off».

Рисунок 1 — Окно «Control Panel»

2. В открывшемся окне «Add Roles and Features Wizard» на вкладке «Installation Type» выберите «Role-based or feature-based installation».

Рисунок 2 — Вкладка «Installation Type» окна «Add Roles and Features Wizard»

3. На вкладке «Server Selection» выберите сервер, для которого будут установлены требуемые компоненты.

Рисунок 3 — Вкладка «Server Selection» окна «Add Roles and Features Wizard»

4. На вкладке «Server Role» выберите компоненты, как показано на рисунке 4.

Рисунок 4 — Вкладка «Server Role» окна «Add Roles and Features Wizard»

5. На вкладке «Features» выберите функции, если это необходимо.

Рисунок 5 — Вкладка «Features» окна «Add Roles and Features Wizard»

6. На вкладке «Confirmation» проверьте выбранные для установки компоненты и нажмите «Install».
7. После завершения установки перезагрузите сервер.

Проверка обязательных компонентов для операционной системы Microsoft Windows 10

Для корректной установки и работы BPMSoft на Microsoft Windows 10 требуется проверить наличие установки обязательных компонентов и при их отсутствии установить недостающие. Для этого требуется выполнить следующие действия:

1. Откройте «Control Panel» и выберите «Programs».
2. Далее выберите «Turn Windows features on or off».
3. В окне «Windows Features» установите недостающие компоненты.

Рисунок 6 — Окно «Windows Features»

Установка сервера кэширования

Для успешного развертывания BPMSoft необходимо установить сервер кэширования. Подробнее: Развертывание сервера кэширования для BPMSoft.

В системных требованиях BPMSoft перечислены поддерживаемые серверы кэширования. Подробнее: Системные требования BPMSoft.

Установка СУБД и восстановление базы данных

Для работы BPMSoft требуется установить одну из СУБД:

• Microsoft SQL;
• PostgreSQL.

Для восстановления базы данных и настроек доступа создайте пользователя с правами на управление сервером базы данных, а для подключения к системе создайте пользователя с правами на чтение и редактирование базы данных.

После чего восстановите базу данных из резервной копии, которая находится в папке «db» корневой директории. Подробнее: Развертывание базы данных.

Развертывание BPMSoft .NET Framework

Для корректной установки и работы BPMSoft на .NET Framework требуется дополнительно проверить, что установлены:

• .NET Core SDK 8.0;
• .NET Framework SDK v 4.7.2.

Развертывание системы состоит из следующих шагов:

• Настройка ConnectionStrings.config;
• Настройка Web.config;
• Настройка сайта и пула приложения для системы в IIS;
• Настройка WebSockets;
• Настройка перевода BPMSoft на HTTPS.

Настройка ConnectionStrings.config

Для работы BPMSoft требуется правильно заполнить файл «ConnectionStrings.config». Для этого требуется распаковать архив с дистрибутивом системы в директорию, на которую будет настроен Internet Information Services (IIS).

После распаковки системы и настройки базы данных, открыть любым текстовым редактором файл «ConnectionStrings.config», который находится в корне директории с дистрибутивами системы.

Описание параметров для настройки:

• db — подключение к восстановленной базе данных;
• redis — подключение к серверу кэширования;
• tempDirectoryPath — путь к временной директории, используемой при установке пакетов;
• elasticsearchCredentials — данные аутентификации в поисковой системы OpenSearch (далее — Search Engine);
• influx — взаимодействие с сервером сбора метрик системы;
• messageBroker — взаимодействие с сервисом RabbitMQ.

Обязательные параметры

Строка подключения к базе данных Microsoft SQL Server

<add name="db" connectionString="Data Source=[Имя сервера БД]; Initial Catalog=[Имя БД]; Persist Security Info=True; MultipleActiveResultSets=True; Integrated Security=SSPI; Pooling = true; Max Pool Size = 100; Encrypt=False;" />

<add name="db" connectionString="Data Source=[Имя сервера БД]; Initial Catalog=[Имя БД]; Persist Security Info=True; MultipleActiveResultSets=True; User ID=[Логин пользователя]; Password=[Пароль пользователя]; Pooling = true; Max Pool Size = 100; Encrypt=False;" />

Строка подключения к базе данных PostgreSQL

Без использования SSL

<add name="db" connectionString="Pooling=true; Database=[Имя БД]; Host=[Имя сервера БД]; Port=[Порт]; Username=[Логин пользователя]; Password=[Пароль пользователя]; Timeout=500; CommandTimeout=400; MaxPoolSize=1024;" />

С использованием SSL

<add name="db" connectionString="Pooling=true; Database=[Имя БД]; Host=[Адрес сервера БД]; Port=[Порт]; Username=[Имя пользователя]; Timeout=500; CommandTimeout=400; MaxPoolSize=1024; Trust Server Certificate=False; Persist Security Info=true; SslMode=VerifyFull; SSL Certificate=[Путь до client.crt]; SSL Key=[Путь до файла client.key]; Root Certificate=[Путь до файла ca.crt]" />

Строка подключения к серверу кэширования

<add name="redis" connectionString="host=[Имя сервера];db=[Номер БД сервера кэширования]; port=[Порт сервера кэширования]; maxReadPoolSize=10; maxWritePoolSize=500; useTls=false;" />

<add name="redis" connectionString="host=[Имя сервера];db=[Номер БД сервера кэширования]; port=[Порт сервера кэширования]; maxReadPoolSize=10; maxWritePoolSize=500; useTls=false; password=[Пароль сервера кэширования]" />

<add name="redis" connectionString="host=[Имя сервера];db=[Номер БД сервера кэширования]; port=[Порт сервера кэширования]; maxReadPoolSize=10; maxWritePoolSize=500; useTls=true; certLocationMode=CertPath; certificatePath=[Путь до файла сертификата]; certificatePassword=[Пароль от сертификата]; sslHost=[Адрес хоста получения сертификата]" />

<add name="redis" connectionString="host=[Имя сервера];db=[Номер БД сервера кэширования]; port=[Порт сервера кэширования]; maxReadPoolSize=10; maxWritePoolSize=500; useTls=true; certLocationMode=CertStore; storeName=[Наименование хранилища сертификатов]; storeLocation=[Расположение хранилища сертификатов]; certFindType=[Критерий для поиска сертификата]; certFindValue=[Значение для поиска сертификата]" />

Строка подключения к временной директории для загрузки пакетов

<add name="tempDirectoryPath" connectionString=[Путь к временной директории] />

Строка подключения к OpenSearch

<add name="elasticsearchCredentials" connectionString="User=[Имя пользователя Search Engine]; Password=[Пароль пользователя Search Engine];" />

Необязательные параметры

<add name="influx" connectionString="url=[Адрес сервиса сбора метрик]; user=[Имя пользователя]; password=[Пароль пользователя]; batchIntervalMs=5000" />

<add name="messageBroker" connectionString="amqp://[Имя пользователя MessageBroker]:[Пароль пользователя]@[Адрес сервера]/[Имя виртуального сервера]; useTls=false" />

<add name="messageBroker" connectionString="amqp://[Имя пользователя MessageBroker]:[Пароль пользователя]@[Адрес сервера]/[Имя виртуального сервера]; useTls=true; certLocationMode=CertPath; certPath=[Путь до файла сертификата]; certPassphrase=[Пароль от сертификата]; serverName=[SAN или CN сертификата сервера]" />

<add name="messageBroker" connectionString="amqp://[Имя пользователя MessageBroker]:[Пароль пользователя]@[Адрес сервера]/[Имя виртуального сервера]; useTls=true; certLocationMode=CertStore; storeName=[наименование хранилища сертификатов]; storeLocation=[расположение хранилища сертификатов]; certFindType=[критерий для поиска сертификата]; certFindValue=[значение для поиска сертификата]; serverName=[SAN или CN сертификата сервера]" />

<add name="clientPerformanceLoggerServiceUri" connectionString="[Адрес сервиса логирования]" />

Если планируется подключение к RabbitMQ, то выполните дополнительную настройку согласно инструкции Обработка бизнес-процессов через RabbitMQ.

Настройка Web.config

Требуется сгенерировать уникальное значение «machineKey» для конфигурационного файла. Подробнее: Настройка Web.config при развертывании BPMSoft .NET Framework

Настройка сайта и пула приложения для системы в IIS

Для работы BPMSoft требуется в Internet Information Services (IIS) создать и настроить соответствующий веб-сайт и пул приложения.

Шаги для создания сайта при развертывании системы:

1. Откройте IIS. В контекстном меню секции «Sites» выберите «Add Website».
2. В появившемся окне введите «Site name», выберите путь к корневой директории системы, введите «Port» и «Host name», где будет располагаться приложение.

Рисунок 7 — Добавление сайта в IIS

3. Нажмите «OK».
4. В контекстном меню секции созданного сайта выберите «Add Application».
5. Введите в поле «Alias» значение «0» и выберите путь к директории «BPMSoft.WebApp», которая расположена в корневой директории системы.

Рисунок 8 — Добавление приложения в IIS

6. Нажмите «OK».

По умолчанию пул приложения запускается от учетной записи «ApplicationPoolIdentity».

Рисунок 9 — Пулы приложений

При запуске от учетной записи «ApplicationPoolIdentity» необходимо выдать доступ на корневую папку системы BPMSoft для группы IIS_IUSRS, как показано на рисунке ниже.

Рисунок 10 — Выдача прав на корневую папку системы BPMSoft

С точки зрения безопасности рекомендуется запускать каждое IIS приложение под отдельным сервисным пользователем. Реализовать это можно, например, с помощью локальной учетной записи.

Для создания локального пользователя bpmsoft выполните следующее:

1. Откройте «Управление компьютером» (Computer Management) → выберите «Локальные пользователи и группы» → перейдите в раздел «Пользователи» → щелкните правой кнопкой мыши → выберите «Новый пользователь».
2. Введите имя пользователя (логин), полное имя, пароль. Для сервисных учетных записей установите признаки «Пароль не истекает» и «Пользователь не может сменить пароль».
3. Нажмите «Создать».

Рисунок 11 — Настройки «Управление компьютером» (Computer Management)

Чтобы назначить пользователя пулу приложений IIS, выполните следующие шаги:

1. Откройте IIS Manager (inetmgr.exe).
2. Перейдите на вкладку «Пулы приложений» (Application Pools).
3. Нажмите правой кнопкой мыши на нужный пул и выберите «Дополнительные настройки» (Advanced Settings).
4. В разделе «Процесс-модель» (Process Model) найдите строку «Удостоверение» (Identity).
5. Выберите «Удостоверение» (Identity) и нажмите на кнопку «...» (...).

Рисунок 12 — Настройки в разделе «Process Model»

6. В открывшемся окне выберите опцию «Custom account» и нажмите «Set».
7. Введите логин (bpmsoft), пароль созданного пользователя и нажмите ОК.

Рисунок 13 — Настройка логина и пароля созданного пользователя

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

Рисунок 14 — Измененное значение параметра Identity

8. Предоставьте необходимые права доступа к директории (изменение, чтение и выполнение, список содержимого папки, чтение, запись) для локального пользователя bpmsoft без полного доступа.

Рисунок 15 — Выдача прав на корневую папку системы BPMSoft

9. После изменений перезапустите пул и приложение в IIS. Это обеспечит безопасный запуск сайта под новым пользователем без использования ApplicationPoolIdentity.
10. После запуска сайта вы сможете проверить в диспетчере задач на вкладке «Подробности» из-под какого пользователя будет запущено данное приложение. В нашем случае процесс w3wp.exe будет запущен под локальным пользователем bpmsoft.

Рисунок 16 — Отображение процесса w3wp.exe в диспетчере задач

Шаги для настройки пула приложения при развертывании системы:

1. Выберите секцию «Applications Pools» и откройте созданный пул.
2. В появившемся окне проверьте, что все пункты аналогичны представленным на рисунке ниже.

Рисунок 17 — Проверка полей пула в IIS

3. Выберите необходимый пул, перейдите в секцию «Advanced Settings», далее в блок «Process Model» и проверьте, что для свойства «Load User Profile» («Загрузить профиль пользователя») установлено значение «true». Включение загрузки профиля необходимо для того, чтобы пользователь приложения (в частности, учетные записи MSA) имел возможность использовать свое домашнее окружение. В окружении создаются папки:
   C:\Users\<MyMsaAccount>\AppData\Roaming\npm и
   C:\Users\<MyMsaAccount>\AppData\Roaming\npm-cache.

Рисунок 18 — Проверка загрузки профиля пользователя («Load User Profile»)

В противном случае, если для свойства «Load User Profile» установлено значение «false», то процесс попытается создать данные папки по пути C:\Windows\System32\config\systemprofile\AppData\Roaming\ и может возникнуть ошибка доступа. В качестве альтернативного способа необходимо раздать права на пользователя пула IIS для папки C:\Windows\System32\config\systemprofile\AppData\Roaming.

4. В секции web-сервера выберите «ISAPI and CGI Restrictions» и проверьте, что выбранная версия «ASP.Net» имеет статус «Allowed».

Рисунок 19 — Проверка версии «ASP.Net» в «ISAPI and CGI Restrictions»

5. В секции web-сервера выберите «Handler Mappings». Нажмите «Edit Feature Permissions» и проверьте, что в появившемся окне установлены все признаки.

Рисунок 20 — Проверка полей в «Edit Feature Permissions»

6. В секции web-сервера выберите «MIME Types». Проверьте, что в списке присутствуют значения «.svg» и «.json». Если такие значение отсутствуют, то нажмите «Add…» и добавьте «.svg» (MIME type: image/svg+xml) и «.json» (MIME type: application/json).

Рисунок 21 — Добавление «MIME Types»

7. Перейдите в секцию созданного сайта и перезапустите его с помощью кнопки «Restart».
8. Откройте сайт, перейдя в браузере по его адресу или с помощью кнопки «Browse» в секции сайта.

Настройка WebSocket

Для корректной работы пользовательских процессов, уведомлений и интеграции с телефонией, требуется включить и настроить «WebSocket».

Требуется, чтобы на сервере приложений была установлена ОС «Microsoft Windows Server 2016» или «Microsoft Windows 8/10», а также приложение «Internet Information Services» (IIS) версии не ниже 8.0.

Для настройки «WebSocket» в системе, работающей на «Microsoft Windows Server 2016» требуется выполнить следующие шаги:

Шаги для настройки пула приложения при развертывании системы:

1. Откройте файл «Web.config», который находится в корневой директории системы, с помощью любого текстового редактора.
2. Проверьте, что значение «inheritInChildApplications» равно «false». А для «httpRuntime», находящимся в той же «location», установлены значения для «maxRequestLength» и «executionTimeout».
3. Откройте файл «Web.config», который находится в директории «BPMSoft.WebApp», корневой директории системы, с помощью любого текстового редактора.
4. Выполните аналогичную проверку значений, как на шаге 2.
5. Проверьте, что значение «wsService» равно
   type="BPMSoft.Messaging.MicrosoftWSService.MicrosoftWSService, BPMSoft.Messaging.MicrosoftWSService" encrypted=" false" portForClientConnection="0"

Настройка перевода BPMSoft на HTTPS

При разворачивании конфигурационные файлы системы настроены на протокол «http». Выполните следующие шаги, чтобы система работала на протоколе «https»:

1. Получите цифровой сертификат в формате «.pfx».

2. Откройте IIS. В секции сервера выберите «Server Certificates».
3. Выберите «Import». В появившемся окне выберите файл сертификата. Укажите пароль и хранилищем сертификатов выберите «Web Hosting».

Рисунок 22 — Окно «Import Certificate»

4. Нажмите «ОК».
5. Перейдите в секцию сайта приложения. Выберите «Bindings».
6. В появившемся окне нажмите «Add». Выберите «Type» — «https», введите «Host name» и выберите добавленный ранее сертификат.

Рисунок 23 — Добавление «Site Bindings»

7. Нажмите «ОК».
8. Перейдите в корневую директорию системы и откройте файл «Web.config» с помощью любого текстового редактора.
9. Найдите в файле параметры «behaviors» и «bindings» и проверьте их значения, чтобы они были равны
   configSource="BPMSoft.WebApp\ServiceModel\https\bindings.config"».
10. Перейдите в директорию «BPMSoft.WebApp» корневой директории системы и откройте файл «Web.config» с помощью любого текстового редактора.
11. Проверьте значение параметра «wsService», которое должно быть равно
    type="BPMSoft.Messaging.MicrosoftWSService.MicrosoftWSService, BPMSoft.Messaging.MicrosoftWSService" encrypted="true" portForClientConnection="443" maxConnectionNumber="100" clearIdleSession="false" clearIdleSessionInterval="120".
12. Проверьте значение параметра «services», которое должно быть равно configSource="ServiceModel\https\services.config".
13. Перезапустите сайт с помощью кнопки «Restart» в IIS.

Если все выполнено верно, то сайт переведен на протокол «https» и можно перейти на сайт, введя в адресной строке «https://[Адрес_сайта]».

Рекомендуем изучить

Дополнительные настройки после развертывания BPMSoft на Windows