Установка и конфигурация сервера Web-клиента

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

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

Если в Web-клиенте планируется работать с функциями модуля Управление архивом, установите серверные компоненты модуля Управление архивом на компьютер с сервером Docsvision перед установкой Web-клиента.

Если Web-клиент уже установлен и планируется дополнительно установить модуль Управление архивом выполните следующие действия:

Установите сначала модуль Управление архивом на сервер Web-клиента.
Затем обновите Web-клиент с установкой компонентов управления архивом.

Используйте только совместимые версии модулей Управление архивом и Web-клиент. Версии 6.1 и выше несовместимы с версиями 5.5.

По вопросам совместимости Управление архивом версий 6.1 и 6.2 с Web-клиентом версии 6.1 и выше проконсультируйтесь со специалистом Docsvision.

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

Установите серверные компоненты Web-клиента следующей командой, предварительно обновив индекс пакетов:
- Astra Linux / Альт Сервер
- РЕД ОС / SberLinux
sudo apt-get update sudo apt-get install docsvision-webclient
sudo dnf makecache sudo dnf install docsvision-webclient

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

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

Запустите пакет установки Docsvision web-client.msi.

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

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

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

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

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

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

Общие компоненты

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

Серверные компоненты: Основные серверные компоненты Web-клиентa, обязательны для установки на сервер Docsvision.
Служба Windows: Основные компоненты Web-клиентa, предоставляющие базовую функциональность, может устанавливаться как на сервер Docsvision, так и отдельно от него.

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

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

Кнопка Сброс

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

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

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

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

Рисунок 4. Установка расширения
Нажмите кнопку Готово для завершения работы мастера установки.
Если данный модуль устанавливается последним, запустите Консоль управления Docsvision и выполните обновление базы данных, следуя инструкции в документации по администрированию модуля "Консоль управления Docsvision":
- "Подключение существующей БД"
- "Создание БД"
Перезапустите службу Сервера Docsvision.

Установка расширения Web-клиента для Консоли управления Docsvision

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

Чтобы установить расширение Web-клиента для Консоли управления Docsvision на сервер под управлением Linux:

Установите расширение Web-клиента для Консоли управления Docsvision

Расширение Web-клиента для Консоли управления Docsvision необходимо для получения списка загруженных решений, импорта решений Web-клиента, получения списка локализаций и видов карточек, а также загрузки новых значений в базу данных.

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

Установите компоненты Расширения Web-клиента для Консоли управления Docsvision следующей командой, предварительно обновив индекс пакетов:

Astra Linux / Альт Сервер
РЕД ОС / SberLinux

sudo apt-get update
sudo apt-get install docsvision-ext-webc-mc

sudo dnf makecache
sudo dnf install docsvision-ext-webc-mc

Перезапустите службу dvwebclient. Служба запускается от имени УЗ Docsvision и не требует ROOT-привилегий.

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

Чтобы установить расширение Web-клиента для Консоли управления Docsvision на сервер под управлением Windows:

Запустите инсталлятор Web-клиента Docsvision web-client.msi, на шаге выбора компонентов выберите компонент "Расширение консоли управления" для Web-клиента:

Рисунок 5. Выбор компонентов Web-клиента для установки

Установка Docsvision Web-клиент Toolkit

Docsvision Web-клиент Toolkit — пакет утилит для Web-клиента, включающий Конструктор Web-разметок и WebToolBuilder. Web-клиент Toolkit поставляется отдельно от инсталлятора Web-клиент и не требует дополнительной установки серверной и клиентской частей модуля.

Системные требования приведены в пункте Требования отдельной установки программы Конструктор Web-разметок.

Установка Docsvision Web-клиент Toolkit выполняется из пакета установки Docsvision web-client toolkit.msi.

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

Чтобы установить Docsvision Web-клиент Toolkit:

Запустите пакет установки Docsvision web-client toolkit.msi.

Рисунок 6. Мастер установки Docsvision Web-клиент Toolkit
Примите условия лицензионного соглашения, чтобы продолжить установку.

Рисунок 7. Условия лицензионного соглашения Docsvision Web-клиент Toolkit
Нажмите кнопку Установить и дождитесь завершения установки.

Рисунок 8. Установка Docsvision Web-клиент Toolkit

В меню Пуск, в группу "Docsvision Web-клиент" будут добавлены ярлыки Конструктор Web-разметок и WebToolBuilder.

Укажите адрес подключения к серверу Docsvision в файле конфигурации:

Обратите внимание, указанный ниже файл конфигурации расположен в ОС Windows по адресу C:\Program Files (x86)\Docsvision\WebClientToolKit\WebLayoutsDesigner.appsettings.json.

WebLayoutsDesigner.appsettings.json — конфигурация программы Конструктор Web-разметок.

{
  "Docsvision": {
    "WebClient": {
      "Server": {
        "SessionManagerConnection": {
          "ConnectionAddress": "http://dvserver.domain.com:5000", (1)
          "BaseName": "alias" (2)
        }
      }
    }
  }
}

1	Адрес сервера Docsvision.
2	Псевдоним БД, от имени которой будет запускаться программа Конструктор Web-разметок.

В Консоль управления Docsvision, на странице Серверы Имя сервера Web-клиент откройте группу настроек "Решения" и выполните импорт стандартных решений для просмотра стандартных разметок Web-клиента.
Нажмите кнопку Применить в правом верхнем углу окна Консоли, чтобы применить настройки Web-клиента и перезапустите службу Сервера Web-клиента.
Если планируется разрешить пользователям открывать файлы из карточек в офисных приложениях, установите и настройте DVWebTool или DVSupService по инструкции в разделе "Установка DVWebTool и DVSupService".

Первичная конфигурация Web-клиента

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

Из интерфейса Консоли управления Docsvision без необходимости работы с форматом .json, начиная с версии 6.1 сборки 1265 и выше, см. ниже раздел Настройки в Консоли управления Docsvision
При помощи настройки в конфигурационном файле модуля, см. ниже раздел Настройки в конфигурационном файле

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

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

Убедитесь, что в конфигурационном файле Web-клиента по адресу /usr/lib/docsvision/webclient/appsettings.json в Linux или C:\Program Files\Docsvision\WebClient\appsettings.json в Windows указаны описанные ниже настройки. Файл может быть изменён в любом текстовом редакторе (потребуются права суперпользователя/администратора). Настройки в конфигурационном файле:

Фрагмент конфигурационного файла Web-клиента:

{
  "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-ключ для подключения к Сервису настроек, можно оставить значение по умолчанию или изменить, главное условие, чтобы значения в конфигурации модулей Сервис настроек и Web-клиент были одинаковые.

Дальнейшие настройки модуля выполняются в Консоли управления Docsvision. Откройте Консоль управления Docsvision на странице Серверы Имя сервера Web-клиент "Группа настроек "Подключения" и настройте следующие параметры:
- Адрес сервера приложений
- Имя пользователя — имя системной учётной записи Docsvision
- Пароль — пароль системной учётной записи
  
  Пароль может быть зашифрован, штамп сертификата шифрования паролей указывается в разделе "Общие настройки сервера приложений".
  
  Отпечаток сертификата указывается без двоеточия, например, D8602179888DC8402B393F11DCA16A3376DDF879, см. подробнее в документации по установке системы, раздел "Защита системной учётной записи". Отпечаток можно не указывать, если шифровать пароль системной учётной записи не планируется.
Откройте Консоль управления Docsvision на странице Серверы Имя сервера Web-клиент "Группа настроек "Подключение".
Перейдите к настройкам "Настройка доменных каталогов" и настройте следующие параметры:
- Тип аутентификации в LDAP
- Полное имя домена
- Логин — имя учётной записи, под которой процесс обращается к ActiveDirectory
- Пароль — пароль учётной записи пользователя для аутентификации LDAP
- Домен по умолчанию — полное имя домена для входа по умолчанию в формате FQDN
При необходимости настройте использование расширенной аутентификации на странице Серверы Имя сервера Сервер приложений "Группа настроек "Расширенная аутентификация".

Перезапустите dvwebclient для Linux и Docsvision Web-client для Windows.

Служба запускается от имени УЗ Docsvision и не требует административных привилегий.

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

{
  "Docsvision": {
    "WebClient": {
      "Authentication": {
        "DefaultDomain": "DOMAIN.COM" (1)
      },
      "Server": {
        "SessionManagerConnection": {
          "ConnectionAddress": "http://dvserver.domain.com:5000" (2)
        }
      }
    },
    "ServiceId": "3ed2fd20-eaf9-8846-7089-b34dd8192328", (3)
    "SettingsService": {
      "ConnectionString": "http://storage-server.com:5200/api", (4)
      "ApiKey": "dvwebclientapikey" (5)
    }
  },
  "Ldap": { (6)
    "AuthType": "Basic", (7)
    "Credential": {
      "UserName": "account@domain.com", (8)
      "Password": "password" (9)
    }
  },
  "DataProtectCertificateThumbprint": "thumbprint", (10)
  "SystemUserAccount": "account@domain.com", (11)
  "SystemUserPassword": "password", (12)
}

1	`DefaultDomain` — домен по умолчанию в формате FQDN.
2	`ConnectionAddress` — адрес сервера Docsvision.
3	`ServiceId` — уникальный идентификатор Сервера приложений, с базами которого будет работать серверная консоль.
4	`ConnectionString` — адрес Сервиса настроек.
5	`ApiKey` — API-ключ Сервиса настроек.
6	`Ldap` — имя и пароль учётной записи, под которой процесс обращается к ActiveDirectory. Пароль можно указывать в открытом или в зашифрованном виде, см. подробнее о шифровании в документации по установке системы, раздел "Защита системной учётной записи"
7	`AuthType` — тип аутентификации: `Basic` — аутентификация через LDAP (подробнее см. в документации модуля Платформа Настройка работы с несколькими доменами), `Oauth` — аутентификация через ЕСИА или Azure.
8	`UserName` — логин пользователя модуля для аутентификации LDAP.
9	`Password` — пароль учётной записи пользователя для аутентификации LDAP.
10	`DataProtectCertificateThumbprint` — отпечаток закрытого ключа шифрования SHA1. Указывается без двоеточия, например, `D8602179888DC8402B393F11DCA16A3376DDF879`, см. подробнее в документации по установке системы, раздел "Защита системной учётной записи". Если шифровать пароль системной учётной записи не планируется, параметр можно удалить.
11	`SystemUserAccount` — имя системной учётной записи Docsvision в формате UPN.
12	`SystemUserPassword` — пароль системной учётной записи рекомендуется хранить в зашифрованном виде. Подробнее про шифрование см. в документации по установке системы, раздел "Защита системной учётной записи".

Запустите службу Web-клиента.

Служба запускается от имени УЗ Docsvision и не требует ROOT-привилегий.

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

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

РЕД ОС / SberLinux

Альт Сервер

$ sudo apt-get purge docsvision-webclient

$ sudo dnf remove docsvision-webclient

$ sudo apt-get remove docsvision-webclient
- Чтобы удалить раширение для Консоли управления Docsvision в ОС Linux, выполните:
  Astra Linux
  
  РЕД ОС / SberLinux
  
  Альт Сервер
  
  $ sudo apt-get purge docsvision-ext-webc-mc
  
  $ sudo dnf remove docsvision-ext-webc-mc
  
  $ sudo apt-get remove docsvision-ext-webc-mc