Установка Сервиса настроек

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

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

Установка Сервиса настроек на сервер под управлением Linux

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

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

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

    • РЕД ОС / SberLinux

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

Установка Сервиса настроек на сервер под управлением Windows

Чтобы установить Сервис настроек на сервер под управлением Windows:

  1. Откройте пакет установки Docsvision Settings service.msi.

    Установка Сервиса настроек
    Рисунок 1. Установка Сервиса настроек

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

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

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

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

    Выбирайте необходимые компоненты в зависимостми от настраиваемого сервера. На основном сервере Docsvision обязательно должны быть установлены "Серверные компоненты" модуля. Для работы модулей, устанавливаемых отдельно (например, Консоль управления Docsvision, Служба фоновых операций, Web-клиент и т.д.), достаточно устанавливать только расширения (при наличии) и общие компоненты. См. "Требования к системе Docsvision" в разделе "Необходимые ресурсы", чтобы определить связь с другими модулями.

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

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

    Служба Windows

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

    Кнопка Сброс

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

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

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

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

    Мастер установки серверной части модуля Базовые объекты
    Рисунок 4. Мастер установки серверной части модуля Базовые объекты

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

Настройка Сервиса настроек

  1. В конфигурационном файле по адресу /usr/lib/docsvision/settingsservice/appsettings.json для Linux и C:\Program Files\Docsvision\SettingsService\appsettings.json для Windows необходимо выполнить минимальные настройки: ApiKey, StorageType, StorageOptions, EncryptionCertificate.

    Фрагмент конфигурационного файла:
    {
  "ApiKey": "SettingsServiceApiKey", (1)
  "StorageOptions": {
    "Providers": [
      {
        "Alias": "SqlStorage",
        "Default": true,
        "StorageType": "DB-type", (2)
        "StorageOptions": "CONNECTION-STRING", (3)
        "ProviderType": "Hierarchy"
      }
    ]
  }
}
    1 Ключ доступа к Сервису настроек — "пароль", который также необходимо указать в конфигурационном файле модулей Консоль управления Docsvision, Платформа, Web-клиент, Управление процессами, Служба фоновых операций и Файловый сервис.
    2 Тип БД: MsSql или PgSql.
    3 Строка подключения к БД. См. подробнее "Строка подключения к базе данных для хранения настроек" далее. При наличии БД Сервиса настроек предыдущей версии, можно использовать её.

  2. После сохранения настроек в конфигурационном файле запустите службу Сервиса настроек.

    В ОС Linux, в версии 6.1, сборка 187 и выше, служба запускается от имени УЗ Docsvision и не требует root-привилегий.

Настройка кластера Сервиса настроек

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

Чтобы настроить кластер Сервиса настроек, выполните следующие действия:

  1. Установите Сервис настроек на первом и последующих узлах кластера согласно для Linux или для Windows.

  2. Убедитесь, что на всех узлах используется один и тот же API ключ доступа и одну и ту же БД для хранения настроек.

  3. Настройте балансировщик нагрузки[1] с режимом active-passive и укажите адрес балансировщика в конфигурационных файлах компонентов, зарегистрированных в текущем Сервисе настроек.

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

Строка подключения содержит адрес подключения к базе данных для хранения настроек. Вид строки подключения зависит от выбранной базы данных.

Для Сервиса настроек необходимо использовать отдельную базу данных. Если БД Сервиса настроек уже создавалась, можно использовать её.

Для Microsoft SQL Server: Data Source=Адрес-сервера-баз-данных;Initial Catalog=Название-БД-Сервиса настроек;Integrated Security=False;User ID=Имя-пользователя-БД;Password=Пароль-пользователя-БД; TrustServerCertificate=false.

  • Data Source — адрес сервера SQL для подключения к БД. В качестве Data Source может быть указан экземпляр SQL-сервера, например так: Data Source=DVDatabse\\Server1.

  • Название-БД-Сервиса настроек — псевдоним базы данных.

  • Integrated Security — задает логическое значение, определяющее способ проверки подлинности:

    • False — при подключении в строке должны быть указаны идентификатор пользователя и пароль.

    • True — при подключении будут использованы учётные данные текущей учётной записи Windows.

  • Имя-пользователя-БД — учётная запись пользователя для подключения к БД.

  • Пароль-пользователя-БД — пароль учётной записи для подключения к БД.

  • TrustServerCertificate=false — подробнее про настройку см. особенности настройки сертификата.

При использовании строки подключения к хранилищу с Windows-аутентификацией для Microsoft SQL Server учётной записи службы Сервиса настроек необходимо предоставить права на создание новых БД, а также полные права на БД, которая будет создана при запуске Сервиса настроек.

Если в строке подключения введены корректные данные, при запуске Сервиса настроек будет создана новая или обновлена существующая БД.

Для PostgreSQL/Pangolin: host=Адрес-сервера-баз данных;Port=SQL-порт;database=Название-БД-Сервиса настроек;Username=Имя-пользователя-БД;Password=Пароль-пользователя-БД.

  • Адрес-сервера-баз данных — адрес сервера SQL для подключения к БД.

  • SQL-порт — порт SQL-сервера.

  • Название-БД-Сервиса настроек — псевдоним базы данных.

  • Имя-пользователя-БД — учётная запись пользователя для подключения к БД.

  • Пароль-пользователя-БД — пароль учётной записи для подключения к БД.

Особенности настройки сертификата

Настройка актуальна только для Microsoft SQL Server, для PostgreSQL дополнительных настроек не требуется. По умолчанию провайдер считает соединение с БД защищённым.

Если соединение не защищено (т.е. не настроен сертификат на уровне БД, используется самозаверенный или недействительный сертификат), необходимо в строке соединения указывать TrustServerCertificate = true, это сообщит провайдеру, что серверу можно доверять.

Настоятельно рекомендуется использовать защищённое соединение, настроив Microsoft SQL сервер в соответствии с инструкцией в руководстве по настройке системы, см. подробнее "Создание доверенного сертификата для подключения к БД".

Удаление Сервиса настроек

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

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

    • Astra Linux

    • РЕД ОС / SberLinux

    • Альт Сервер

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

Созданные группы и службы будут удалены, Сервис настроек станет недоступен.

1. Описание настройки балансировщика выходит за рамки документации Docsvision.