Редакция web-клиента на ASP.NET Core 6.0 для системы управления данными Pilot

Всё необходимое для устновки Pilot-Server и myAdmin здесь.
Инструкция развёртывания всех компонентов Pilot-ICE.

Данное описание и настройка описана для операционной системы Ubuntu.

• Содайте папку /opt/pilot-web и скачайте туда архив pilot-web_linux.zip

# mkdir /opt/pilot-web
$ cd /opt/pilot-web

• Распакуйте архив в созданную папку

# unzip pilot-web.zip

• Задайте права на запуск для библиотеки Pilot.Web

# chmod +x Pilot.Web

Для корректной работы Pilot-Web клиента, мы рекомендуем использовать обратный прокси сервер для обработки входящих соединений. Например: Apache или Nginx. Инструкцию по установке и настройке вы можете найти в соответствующем разделе выбранного вами обратного-прокси сервера.

Пример настройки для Nginx:

server {
        listen 80;
        listen [::]:80;

        access_log /var/log/nginx/reverse-access.log;
        error_log /var/log/nginx/reverse-error.log;

        location / {
                    proxy_pass http://127.0.0.1:5000;
  }
}

Для того, чтобы Pilot-Web клиент смог обрабатывать документы формата xps и отображать их содержимое в окне браузера необходимо установить дополнительный пакет инструментов обработки документов mupdf-tools

sudo apt update
sudo apt install mupdf-tools

Домашняя страница проекта http://mupdf.com/

Для настройки автозапуска необходимо использовать настройку служб инициализации systemd или supervisor.

Из соображений безопасности рассмотренные сервисы целесообразно запускать и останавливать от имени специально созданного пользователя, например: pilotwebuser.

Для этого:

• Создайте учетную запись pilotwebuser, от которой будет запускаться и работать Pilot-Web клиент:

adduser pilotwebuser --no-create-home

• Назначьте пользователя pilotwebuser владельцем каталога и файлов /opt/pilot-web:

chown pilotwebuser -Rv /opt/pilot-web

Один из способов настройки автозапуска реализуется через подсистему инициализации GNU/Linux systemd.

Для того, чтобы автоматически запускать Pilot-Web подключите следующий юнит в systemd:

Юнит автозапуска pilot-web.service:

[Unit]
Description=Pilot-Web

[Service]
User=pilotwebuser
Group=pilotwebuser
WorkingDirectory=/opt/pilot-web
Restart=always
RestartSec=10
SyslogIdentifier=dotnet-pilot-web-client
Enviroment=ASPNETCORE_ENVIROMENT=Production
ExecStart=/opt/pilot-web/Pilot.Web
ExecStopp=/bin/kill -s 3 $MAINPID

[Install]
WantedBy=multi-user.target

После содания нового юнита его необходимо включить. Для этого:

• Включите автозапуск сервиса pilot-web.service:

systemctl enable pilot-web.service

• Перезагрузите демон:

systemctl daemon-reload

• Запустите Pilot-Web:

systemctl start pilot-web

Pilot-Web на Windows можно запустить как web-приложение в службе IIS (Internet Information Services).

Для того, чтобы запустить Pilot-Web в службе IIS необходимо:

• Включить Службы IIS в компонентах Windows.
• Установить ASP.NET Core Runtime 6.0.5 (https://dotnet.microsoft.com/download/dotnet/6.0), если еще не установлен
• Распаковать архив pilot-web_windows.zip в папку для web-сайтов IIS (например C:\wwwroot\pilot-web)
• Добавить сайт в IIS. Для этого в Диспетчере служб IIS вызовите из контекстного меню узла Сайты -> Добавить веб-сайт. В диалоговом окне задайте параметры нового сайта:
  • задайте имя для сайта, например: PilotWeb
  • укажите физический путь до папки, в которую были скопированы файлы PilotWeb
  • задайте тип привязки: http, IP-адрес, порт.

В клиенте Pilot-Web существует ряд настроек, которые необходимо установить перед запуском системы.

Основные настройки клиента расположены в файле appsettings.json. Все настройки разбиты по секциям.

"PilotServer": {
    "Url": "http://localhost:5545",
    "Database": "basename",
    "LicenseCode": 103
  }

где:
Url - адрес подключения к серверу Pilot-Server.
Database - имя базы данных, к которой осуществляется подключение.
LicenseCode - номер лицензии

Т.к. Pilot-Web преобразует полученные от Pilot-Server файлы в формате xps в картинки. Чтобы повторно не конвертировать такие файлы используется локальное хранилище преобразованных картинок.

"AppSettings": {
    "FilesStorageDirectory": "C:/PilotWebStorage",
    "DisplacementFactor": 1.248
  }

где:
FilesStorageDirectory - корневая папка для локального хранилища

ℹ️ На системах Windows для указания папки локального хранилища используйте косую черту / или двойную обратную косую черту \\. Например C:\\Temp\\PilotWebStorage или C:/Temp/PilotWebStorage.

DisplacementFactor - коэффициент смещения замечаний на документе.

ℹ️ Т.к. для рендеринга документов на Windows и Linux используются разные инструменты, необходимо задать коэффициент смещения для правильного позиционирования замечаний на документе.
Для Windows рекомедуется использовать значение 1.
Для Linux рекомендуется установить значение 1.248.
В случае, если замечания будут смещены относительно документ выставите коэффициент смещения методом подбора.

Для обеспечения безопасности авторизации на сервере Pilot-Web необходимо задать следующие настройки:

"AuthSettings": {
    "Issuer": "PilotWebIssuer",
    "SecretKey": "SecretKey@30824995-BD42-4850-87ED-EE8A2AE06ACA",
    "TokenLifeTimeDays": 2,
    "IdleSessionTimeout": 20
  }

где:
Issuer - имя издателя токена авторизации.
SecretKey - секретный ключ для формирования токена. Должен содержать различные символы и цифры.
TokenLifeTimeDays - продолжительность жизни токена (в днях).
IdleSessionTimeout - время бездействия, пользователя после которого клиент отключается от сервера Pilot-Server.

Для того, чтобы настроить логирование необходимо указать путь куда будет писаться лог. По умолчаний файлы с логами будут лежать рядом с клиентом в папке Logs.
Для того, чтобы задать расположения файла для логов откройте файл logger.config. И измените путь для файла в строке:<conversionPattern value="Logs/web_server.log" />на нужный:

<appender name="FileAppender" type="log4net.Appender.RollingFileAppender">
      <file type="log4net.Util.PatternString">
        <conversionPattern value="Logs/web_server.log" />
      </file>
      ...
</appender>

При изменении пути файлов лога не забудьте установить права для pilotwebuser на запись для папки с логами.