Конфигурация Сервера приложений

Модуль "Платформа" поддерживает следующие варианты конфигурации модуля:

Конфигурация Сервера приложений из Консоли управления Docsvision

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

  1. Откройте конфигурационный файл в любом текстовом редакторе (потребуются права суперпользователя/администратора) и заполните следующие параметры:

    Фрагмент конфигурационного файла appsettings.json:
    {
  "DocsVision": {
    "ServiceId": "00000000-0000-0000-0000-000000000000", (1)
    "SettingsService": {
      "ConnectionString": "http://localhost:5200/api", (2)
      "ApiKey": "anything" (3)
    },
  },
  "AllowedHosts": "*",
  "Kestrel": { (4)
    "Endpoints": {
      "Http": {
        "Url": "http://*:5000"
      }
    }
  }
}
    1 ServiceId — уникальный идентификатор данного экземпляра модуля, генерируется и записывается автоматически.
    2 ConnectionString — полный адрес Сервиса настроек.
    3 ApiKey — API-ключ для подключения к Сервису настроек, можно оставить значение по умолчанию или изменить, главное условие, чтобы значения в конфигурации модулей Сервис настроек и Платформа были одинаковые. Адрес и API-ключ требуется указать, если планируется переходить в Консоль управления Docsvision из карточек Web-клиента и Windows-клиента.
    4 Настройка защищённого (HTTPS) соединения с Сервером приложений для защиты конфиденциальных данных, см. подробнее Подключение к Docsvision по HTTPS.

  2. Перезапустите службу dvappserver для Linux и Docsvision Platform для Windows, чтобы применить настройки конфигурационного файла.

  3. На странице "Управление доступом" и укажите параметры:

    • Логин системной учётной записи.

      Не рекомендуется авторизоваться на клиентских рабочих местах под системными учётными записями, т.к. это может привести к ошибкам в работе системы.

    • Пароль системной учётной записи.

    • Имя компьютера в текущем домене Active Directory — используется для получения списка доступных членов домена при настройке дискреционной безопасности.

  4. Нажмите кнопку Применить в правом верхнем углу окна Консоли, чтобы применить настройки.

  5. Откройте Консоль управления Docsvision на странице Серверы  Имя-сервера  Сервер приложений, перейдите в раздел "Настройка доменных каталогов" и заполните параметры в таблице согласно указаниям на странице "Страница "Домен" для создания доменного каталога".

    Настройка доменных каталогов в Консоли управления Docsvision
    Рисунок 1. Настройка доменных каталогов в Консоли управления Docsvision

  6. Нажмите кнопку Применить в правом верхнем углу окна Консоли, чтобы применить настройки доменных каталогов и перезапустите службу dvappserver для Linux и Docsvision Platform для Windows.

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

    Настройка групп пользователей в Консоли управления Docsvision
    Рисунок 2. Настройка групп пользователей в Консоли управления Docsvision
    Список основных групп пользователей представлен ниже:

    • DocsVision Users — все пользователи, совершившие вход в систему. Входить могут только пользователи из справочника сотрудников.

    • DocsVision Power Users — продвинутые пользователи, имеющие повышенные права.

    • DocsVision Administrators — администраторы системы, обладающие максимальными правами. Могут входить без регистрации в справочнике сотрудников.

    • DocsVision Security Administrators — администраторы безопасности, обладающие самыми высокими правами, могут изменить уровень безопасности для пользователей и карточек.

    • DocsVision Archive Operators — пользователи, имеющие право на удаление архивных карточек.

    • Docsvision Search Query Creators — пользователи, имеющие право создавать новые поисковые запросы.

    • Docsvision Workflow Process Creators — пользователи, имеющие возможность создания нового БП.

    • DocsVision Aggregation Users — пользователи, для которых доступна агрегация в представлениях.

    • Docsvision Management Console Administrators — пользователи, которым разрешается просматривать карточки сообщений в Консоли управления Docsvision. Группа не предоставляет доступ к Консоли управления Docsvision.

      Чтобы предоставить доступ к Консоли управления Docsvision добавьте пользователей в группу Docsvision Management Console Administrators в конфигурационном файле Консоли управления Docsvision. Остальные группы могут быть заполнены из интерфейса консоли.

  8. Нажмите кнопку Применить в правом верхнем углу окна Консоли, чтобы применить настройки сервера приложений.

  9. Перезапустите службу dvappserver для Linux и Docsvision Platform для Windows.

  10. В разделе "Общие настройки сервера приложений" укажите параметры:

    • Файл журнала и Уровень журналирования — путь к файлу, в котором регистрируются выполняемые сервером операции.

    • API-ключ для подключения к Workflow — используется для подключения серверного расширения Управление процессами. Главное условие, чтобы значения в конфигурации модулей Платформа и Управление процессами были одинаковые.

    • Штамп сертификата шифрования паролей — отпечаток закрытого ключа шифрования SHA1.
      Указывается без двоеточия, например, D8602179888DC8402B393F11DCA16A3376DDF879, см. подробнее в документации по настройке системы, раздел "Защита системной учётной записи".
      Если шифровать пароль системной учётной записи не планируется, параметр можно не указывать.

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

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

  13. Нажмите кнопку Применить в правом верхнем углу окна Консоли, чтобы применить настройки сервера приложений и перезапустите службу dvappserver для Linux и Docsvision Platform для Windows.

Конфигурация Файлового сервиса в конфигурационном файле

  1. Укажите существующую БД, заполнив строку подключения к БД в конфигурационном файле:

    {
  "DocsVision": {
    "Server": {
      "Databases": {
        "alias": "Database-connection-string" (1)
      }
    }
  },
  "NLog": { (2)
  },
  "AllowedHosts": "*",
  "Kestrel": { (3)
  }
}
    1 alias — строка подключения к БД.
    2 NLog — настройки жерналирования, см. "Журнал работы файлового сервиса"
    3 Kestrel — настройка доступа к Storage Server по HTTPS, см. подробнее Подключение к Docsvision по HTTPS.

Конфигурация Файлового сервиса в консоли

Ниже перечислены минимально необходимые настройки конфигурационного файла Файлового сервиса по адресу appsettings. Файл необходимо заполнять в любом случае при свежей установке системы, при обновлении системы с предыдущих версий можно принять решение оставить существующий конфигурационный файл.

{
  "DocsVision": {
    "ServiceId": "00000000-0000-0000-0000-000000000000", (1)
    "SettingsService": {
      "ConnectionString": "http://localhost:5200/api", (2)
      "ApiKey": "anything" (3)
    }
  }
}
1 ServiceId — уникальный идентификатор данного экземпляра модуля, генерируется и записывается автоматически.
2 ConnectionString — адрес Сервиса настроек.
3 ApiKey — API-ключ Сервиса настроек.

  1. В Консоли управления Docsvision перейдите на страницу Серверы  Имя сервера  Файловый сервис  Группа настроек "Базы данных", чтобы подключить БД к Файловому сервису.

    Группа настроек "Базы данных" для файлового сервиса
    Рисунок 3. Группа настроек "Базы данных" для файлового сервиса

  2. Нажмите кнопку Подключить под таблицей, чтобы открыть окно подключения БД из доступных к файловому сервису.

    Окно подключения БД для использования в файловом сервисе
    Рисунок 4. Окно подключения БД для использования в файловом сервисе

  3. Выберите БД при помощи флага и нажмите кнопку Применить.

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

Конфигурация сервиса полнотекстового индексирования

  1. Все настройки сервиса полнотекстового индексирования хранятся в конфигурационном файле /usr/lib/docsvision/fulltextservice/appsettings.json для Linux и C:\Program Files\Docsvision\FullTextService\appsettings.json для Windows. Откройте конфигурационный файл в любом текстовом редакторе и выполните необходимые настройки сервиса:

    {
  "DocsVision": {
    "Platform": {
      "Server": {
        "LogFile": "/var/log/docsvision/fulltextservice.log", (1)
        "Databases": {
          "alias": "CONNECTION-STRING" (2)
        }
      }
    }
  },
  "DataProtectCertificateThumbprint": "thumbprint", (3)
  "SystemUserAccount": "account@domain.com", (4)
  "SystemUserPassword": "password" (5)
}
    1 Путь к файлу журнала полнотекстового поиска.
    2 Строка подключения к индексируемой БД.
    3 Отпечаток закрытого ключа шифрования SHA1.
    Указывается без двоеточия, например, D8602179888DC8402B393F11DCA16A3376DDF879, см. подробнее в документации по настройке системы, раздел "Защита системной учётной записи".
    Если шифровать пароль системной учётной записи не планируется, параметр можно удалить.
    4 Имя системной учётной записи Docsvision.
    Не рекомендуется авторизоваться на клиентских рабочих местах под системными учётными записями, т.к. это может привести к ошибкам в работе системы.
    5 Пароль системной учётной записи рекомендуется хранить в зашифрованном виде. Подробнее про шифрование см. в документации по настройке системы, раздел "Защита системной учётной записи".

  2. Запустите службу Сервиса полнотекстового индексирования.

(Старый метод) Конфигурация модуля Платформа без Консоли управления Docsvision

Конфигурационный файл может быть изменён в любом текстовом редакторе, файл располагается по адресу appsettings.

Фрагмент конфигурационного файла appsettings.json:
{
  "DocsVision": {
    "Platform": {
      "Server": {
        "DefaultBaseName": "alias", (1)
        "LogFile": "/var/log/docsvision/dvappserver.log", (2)
        "WindowsSecurityServerName": "any.domain.com", (3)
        "Databases": {
          "alias": "CONNECTION-STRING"  (4)
        }
      }
    },
    "ServiceId": "00000000-0000-0000-0000-000000000000", (5)
    "SettingsService": {
      "ConnectionString": "ConnectAddress=http://settings.service.com:5200/api", (6)
      "ApiKey": "apikey-settingsservice" (7)
    },
    "Workflow": {
      "ApiKey": "api-key" (8)
    }
  },
  "Groups": {
    "DocsVision Administrators": [
      "domain\\account"
    ], (9)
    "DocsVision Security Administrators": [
      "domain\\account"
    ],
    "Docsvision Management Console Administrators": [
      "domain\\account"
    ],
  },
  "Ldap": { (10)
    "AuthType": "Basic", (11)
    "Credential": {
      "UserName": "account@domain.com", (12)
      "Password": "password" (13)
    }
  },
  "Catalogs": [
    "DOMAIN.COM" (14)
  ],
  "DataProtectCertificateThumbprint": "thumbprint", (15)
  "SystemUserAccount": "account@domain.com", (16)
  "SystemUserPassword": "password", (17)
  "Logging": { (18)
    "LogLevel": {
      "Default": "Error"
    }
  }
}
1 DefaultBaseName — псевдоним базы данных. Должен совпадать с псевдонимом подключаемой базы в Консоли настройки. Можно заполнить заранее, или вернуться позже, после создания из Консоли управления.
2 LogFile — путь к файлу журнала сервера. Параметр необязательный, если он не указан, действует системная настройка по умолчанию.
3 WindowsSecurityServerName — необходимо указать имя любого компьютера в текущем домене Active Directory. Используется при получении списка доступных членов домена при настройке дискреционной безопасности в Windows-клиенте, РМА и DVExplorer.
4 alias — псевдоним используемой БД, для которой задаётся строка подключения. CONNECTION-STRING — строка подключения, подробное описание строки подключения см. ниже.
5 ConnectionString — полный адрес Сервиса настроек. Если Сервис настроек ещё не установлен, адрес можно заполнить позднее.
6 ServiceId — уникальный идентификатор данного экземпляра модуля, генерируется и записывается автоматически.
7 ApiKey — используется для подключения серверного расширения Управление процессами. API-ключ для подключения к Сервису настроек, можно оставить значение по умолчанию или изменить, главное условие, чтобы значения в конфигурации модулей Сервис настроек и Платформа были одинаковые. Если модуль Управление процессами ещё не установлен, можно оставить значение по умолчанию или изменить, главное условие, чтобы значения в конфигурации модулей Платформа и Управление процессами были одинаковые.
8 Groups — эквивалент системных групп. Указанные в группах пользователи будут обладать соответствующими правами. Обратите внимание, что в группах массив строк, а не строка.
Пользователь, выполняющий установку и настройку системы должен входить в группы:

  • DocsVision Administrators и DocsVision Security Administrators — администраторы системы и администраторы безопасности системы.

  • Docsvision Management Console Administrators. Пользователи, входящие в эту группу, имеют право просматривать карточки сообщений в Консоли управления Docsvision.

  • Также через конфигурационный файл выполняется настройка клиентской части, см. подробнее Настройки Windows-клиента и РМА.
9 Ldap — имя и пароль учётной записи, под которой процесс обращается к ActiveDirectory.
10 AuthType — тип аутентификации: Basic — аутентификация через LDAP, Oauth — аутентификация через ЕСИА или Azure.
11 UserName — логин пользователя модуля для аутентификации LDAP.
12 Password — пароль учётной записи пользователя для аутентификации LDAP в открытом или в зашифрованном виде, см. подробнее о шифровании в документации по установке системы, раздел "Защита системной учётной записи".
13 Catalogs — настройки доменных каталогов сервера Docsvision, см. "Настройка работы с несколькими доменами".
14 DataProtectCertificateThumbprint — отпечаток закрытого ключа шифрования SHA1.
Указывается без двоеточия, например, D8602179888DC8402B393F11DCA16A3376DDF879, см. подробнее в документации по установке системы, раздел "Защита системной учётной записи".
Если шифровать пароль системной учётной записи не планируется, параметр можно удалить.
15 SystemUserAccount — имя системной учётной записи Docsvision.
Не рекомендуется авторизоваться на клиентских рабочих местах под системными учётными записями, т.к. это может привести к ошибкам в работе системы.
16 SystemUserPassword — пароль системной УЗ рекомендуется хранить в зашифрованном виде, см. подробнее в документации по установке системы, раздел "Защита системной учётной записи".
17 Logging — настройка упразднена, используйте параметр LogFile или настройте журналирование с помощью NLog.