Установка и настройка Службы фоновых операций

Перед установкой ознакомьтесь с разделом "Необходимые ресурсы".

Пользователь, выполняющий установку, должен обладать правами локального администратора и являться администратором Docsvision (быть членом группы Администраторы в Справочнике сотрудников).

Установка Службы фоновых операций на сервер под управлением Linux

  1. Установите серверные компоненты Службы фоновых операций следующей командой, предварительно обновив индекс пакетов:

    • Astra Linux / Альт Сервер

    • РЕД ОС / SberLinux

    sudo apt-get update
sudo apt-get install docsvision-workerservice
    sudo dnf makecache
sudo dnf install docsvision-workerservice

  2. Приоритетным способом настройки системы является Консоль управления Docsvision, но настройки в конфигурационном файле Configuration.json имеют приоритет перед Консолью управления, см. подробнее "Страница "Серверы"" в документации Консоли управления Docsvision. Это сделано с целью оставить возможность постепенного перехода от настройки модулей через конфигурационные файлы к конфигурации через Консоль управления Docsvision.

  3. Если данный модуль устанавливается последним, запустите Консоль управления Docsvision и выполните обновление базы данных, следуя инструкции в документации по администрированию модуля "Консоль управления Docsvision":

  4. Перезапустите службу Сервера Docsvision.

Установка Службы фоновых операций на сервер под управлением Windows

  1. Запустите пакет установки Docsvision Worker service.msi.

    Мастер установки Службы фоновых операций
    Рисунок 1. Мастер установки Службы фоновых операций

  2. Примите условия лицензионного соглашения, чтобы продолжить установку, и нажмите кнопку Далее.

    Условия лицензионного соглашения
    Рисунок 2. Условия лицензионного соглашения

  3. Выберите компоненты, которые требуется установить, и нажмите Далее.

    Выбор устанавливаемых компонентов
    Рисунок 3. Выбор устанавливаемых компонентов
    Общие компоненты

    Обеспечивают взаимодействие с сервером Docsvision, обязательны для установки на сервер Docsvision и сервер Службы фоновых операций.

    Серверные компоненты

    Основные серверные компоненты Службы фоновых операций, обязательны для установки на сервер Docsvision.

    Служба Windows

    Основные компоненты Службы фоновых операций, предоставляющие базовую функциональность, обязательна для установки на сервер Docsvision.

    Расширение Консоли управления Docsvision

    Расширение Консоли управления Docsvision необходимо для настройки служб в Консоли и просмотра сообщений.

    Кнопка Сброс

    Сбрасывает выбор компонентов на стандартные.

    Кнопка Использование диска

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

  4. Нажмите кнопку Установить, чтобы начать установку или кнопку Назад, чтобы вернуться на предыдущий шаг.

    Продолжить установку или вернуться на предыдущий шаг
    Рисунок 4. Продолжить установку или вернуться на предыдущий шаг

  5. Нажмите кнопку Готово, чтобы закрыть мастер установки.

  6. Если данный модуль устанавливается последним, запустите Консоль управления Docsvision и выполните обновление базы данных, следуя инструкции в документации по администрированию модуля "Консоль управления Docsvision":

  7. Перезапустите службу Сервера Docsvision.

Установка расширения Службы фоновых операций для Консоли управления Docsvision

Расширение Службы фоновых операций для Консоли управления Docsvision добавляет функциональность для работы со Службой фоновых операций: настройка службы в Консоли, просмотр сообщений, расширение обязательно для установки в версии Консоли управления Docsvision 6.2 и выше.

Установка расширения Службы фоновых операций на сервер под управлением Linux

Чтобы установить расширение Службы фоновых операций для Консоли управления Docsvision:

  1. Выполните следующие команды, чтобы установить Расширение Службы фоновых операций для Консоли управления Docsvision:

    • Astra Linux / Альт Сервер

    • РЕД ОС / SberLinux

    sudo apt-get update
sudo apt-get install docsvision-ext-ws-mc
    sudo dnf makecache
sudo dnf install docsvision-ext-ws-mc

  2. Перезапустите службу dvworkerservice.

Установка расширения Службы фоновых операций на сервер под управлением Windows

Чтобы установить расширение Службы фоновых операций для Консоли управления Docsvision на сервер под управлением Windows:

  1. Запустите инсталлятор Службы фоновых операций Docsvision Worker service.msi, на шаге выбора компонентов выберите компонент "Расширение консоли управления" для Службы фоновых операций:

    Выбор компонентов Службы фоновых операций для установки
    Рисунок 5. Выбор компонентов Службы фоновых операций для установки

Настройка Службы фоновых операций

Служба фоновых операций имеет два конфигурационных файла, расположенных по адресу /usr/lib/docsvision/workerservice/ в Linux и C:\Program Files\Docsvision\WorkerService\ в Windows. Конфигурационный файл Configuration.json предназначается для настройки защищённого подключения для Службы фоновых операций.

Файл appsettings.json содержит основные настройки для работы системы Docsvision: SettingsServiceConnectionString, ApiKey, RestApiAddress, LogFile.

В конфигурационном файле appsettings.json располагаются настройки защищённого соединения.

Фрагмент конфигурационного файла "appsettings.json":
{
  "Kestrel": { (1)
    "Endpoints": {
      "Http": {
        "Url": "http://*:5900"
      }
    }
  }
}
1 Настройка защищённого (HTTPS) соединения для Службы фоновых операций для защиты конфиденциальных данных, см. подробнее "Подключение к Docsvision по HTTPS". Настройка также позволяет задать порт и адрес подключения к Службе фоновых операций.
Фрагмент конфигурационного файла "Configuration.json":
{
  "SettingsServiceConnectionString": "ConnectAddress=http://settings.domain.com:5200/api", (1)
  "ApiKey": "anything", (2)
  "RestApiAddress": "http://worker.domain.com:5900/api", (3)
  "LogTraceLevel": "1" (4)
}
1 Адрес подключения к Сервису настроек.
2 Ключ доступа к Сервису настроек — "пароль", который также должен быть указан в конфигурационном файле сервиса.
3 Адрес подключения к Службе фоновых операций.
4 Уровень журналирования Службы фоновых операций, см. подробнее "Журнал работы".

Установка клиентской части модуля из установочного пакета

Клиентские компоненты модуля предназначены для установки на компьютеры пользователей Windows-клиента.
Чтобы установить клиентскую часть модуля вручную:

  1. Запустите пакет установки Docsvision Worker service client.msi вручную.

    Настройка клиентской части модуля, включая область и каталог установки, осуществляется в конфигурационном файле Windows-клиента, см. подробнее раздел "Настройки Windows-клиента и РМА" в документации модуля Платформа.
    Если использовать Windows-клиент не планируется, настройки можно пропустить.

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

  3. Нажмите на кнопку Установить и дождитесь завершения установки модуля.

  4. Нажмите на кнопку Готово, чтобы закрыть мастер установки.

Удаление модуля

  • Чтобы удалить модуль в ОС Windows, воспользуйтесь стандартными средствами системы (Установка и удаление программ).

  • Чтобы удалить модуль в ОС Linux, выполните команду:

    • Astra Linux

    • РЕД ОС / SberLinux

    • Альт Сервер

    $ sudo apt-get purge docsvision-workerservice
    $ sudo dnf remove docsvision-workerservice
    $ sudo apt-get remove docsvision-workerservice

    • Чтобы удалить раширение для Консоли управления Docsvision в ОС Linux, выполните:

      • Astra Linux

      • РЕД ОС / SberLinux

      • Альт Сервер

      $ sudo apt-get purge docsvision-ext-ws-mc
      $ sudo dnf remove docsvision-ext-ws-mc
      $ sudo apt-get remove docsvision-ext-ws-mc

      Компоненты модуля и расширение следует удалять до удаления компонентов модуля Платформа.