1.Архив с Directum Launcher распакуйте в локальную папку на сервере с помощью команды:

tar -xvf <Имя архива> -С <Имя папки>

ВАЖНО. Для корректной установки не перемещайте и не переименовывайте папку после распаковки архива. Общий путь к файлам должен быть не более 256 символов. Также он не должен содержать пробелы, символы кириллицы, запятые и спецсимволы. Поэтому используйте, например, папку /srv/DirectumLauncher. В зависимости от настроек операционной системы для дальнейших действий могут потребоваться права суперпользователя.

2.В корень папки скопируйте архивы:

•Platform.tar.gz – веб-сервер и сервисы Directum RX;

•DirectumRX.tar.gz – набор стандартных шаблонов документов, утилита RxCmd и стандартная прикладная разработка Directum RX.

Примечание. Для систем с заказной разработкой в архиве содержится утилита RxCmd, которая позволяет импортировать свои шаблоны документов, а также запускать и настраивать под себя интеллектуальную обработку документов. Поэтому при установке системы указываются оба пакета разработки: с заказной и со стандартной;

•DockerImages.tar.gz – базовые docker-образы. Скопируйте архив, если на сервере отсутствует доступ к сети Интернет;

•WebHelp.zip – справка и слайдер.

Некоторые компоненты зависят друг от друга. Например, без актуальной платформы нельзя добавить прикладную разработку. Версии зависимых компонентов должны быть совместимы. Если зависимый компонент нужной версии не найден в папке с Directum Launcher, то при запуске инструмента установки возникнет ошибка. Проверьте, что все нужные архивы есть в папке.

В таблице приведены примеры компонентов, у которых есть зависимости:

3.Увеличьте максимально допустимое количество наблюдателей за файлами на текущем компьютере – системный параметр /proc/sys/fs/inotify/max_user_instances. Для этого в командной строке перейдите в созданную папку и с привилегиями суперпользователя выполните команду:

./do.sh set_inotify_instances_limit

4.Дальнейшие действия выполняйте под учетной записью пользователя, от имени которого запущена служба Docker. Если используется учетная запись без привилегий суперпользователя, то выдайте пользователю полные права на папку с Directum Launcher и вложенные в нее папки и файлы.

5.Если в компании не используется DNS-сервер, создайте конфигурационный файл config.yml на основе файла DirectumLauncher/etc/config.yml.example. В созданном файле перед секцией logs_path добавьте секцию extra_hosts. Укажите в ней соответствие IP-адреса текущего сервера и доменного имени, по которому доступна система Directum RX.

Пример настройки:

extra_hosts:

    company-rx.directum.ru: '192.168.0.42'
logs_path: &logs
    LOGS_PATH: '{{ home_path }}/logs'

Во время установки указанное соответствие запишется в файл hosts docker-контейнеров. Это необходимо для корректного импорта шаблонов документов и пакетов разработки.

Примечание. Настройка секции extra_hosts также может потребоваться, если используемый дистрибутив Linux не поддерживает работу docker-контейнеров с DNS.

6.Если служба Docker запускается от учетной записи без привилегий суперпользователя (в режиме Rootless), то добавьте переменную is_rootless, иначе пропустите этот шаг. Создайте конфигурационный файл config.yml на основе файла DirectumLauncher/etc/config.yml.example, если он еще не создан. В секцию variables добавьте переменную is_rootless и укажите для нее значение true – использовать режим работы без привилегий суперпользователя. Значение по умолчанию false.

Пример настройки:

variables:

  is_rootless: 'true'

7.Запустите Directum Launcher с помощью команды

./DirectumLauncher --host=0.0.0.0

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

Страницу можно открыть вручную по ссылке http://<IP-адрес сервера, где выполняется установка>:5000/, например, если случайно закрыли браузер. По умолчанию используется порт 5000. Порт можно изменить, добавив к команде ключ --port=<номер порта>.

ПРИМЕЧАНИЕ. С помощью ключей запуска можно подключиться к Directum Launcher с другого компьютера, настроить аутентификацию для входа и использовать защищенный протокол HTTPS. Также можно сменить локализацию на английскую. Подробнее см. раздел «Дополнительные параметры запуска Directum Launcher».

8.По умолчанию при установке системы используются базовые docker-образы из репозитория registry.directum.ru/directum. Можно использовать свои docker-образы, например, если в компании есть жесткие требования безопасности.

Для этого последовательно выполните действия:

•подготовьте базовые docker-образы;

•сгенерируйте конфигурационный файл. Для этого в Directum Launcher нажмите на кнопку Сохранить;

•откройте страницу Настройка и перейдите в режим редактирования YAML;

•в секцию variables добавьте переменную image. В ее параметрах name и version задайте имя и версию образа.

ВАЖНО. Имя и версия должны совпадать со значениями, указанными для переменных окружения REPO_NAME, IMAGE_NAME и IMAGE_VERSION в скрипте сборки образов set_vars.ps1.

Пример настройки в скрипте set_vars.ps1:

$env:IMAGE_VERSION='4.1.0'
$env:REPO_NAME='registry.directum.ru/directum/'
$env:IMAGE_NAME='rx-base'

Пример настройки в конфигурационном файле config.yml:

variables:

    image:
        name: 'registry.directum.ru/directum/rx-base'
        version: '4.1.0'

•сохраните изменения.

ПРИМЕЧАНИЕ. Если в организации используются мобильные решения, настройте использование собственных docker-образов при установке сервиса NOMAD.

9.На странице Развертывание убедитесь, что выбран режим Установка, и укажите настройки веб-сервера:

Platform. Убедитесь, что флажок установлен. Если флажок не установлен, то поля с настройками веб-сервера и сервисов Directum RX недоступны.

Адрес сайта, по которому доступна система. По умолчанию заполняется полным доменным именем текущего компьютера. Для работы через Интернет необходимо указать внешнее зарегистрированное DNS-имя сайта, например rx.company.ru.

ВАЖНО. После установки системы изменять адрес сайта не рекомендуется.

Протокол, который будет использоваться для работы с системой. Возможные значения: https, http. Значение по умолчанию https. Для работы с системой рекомендуется использовать защищенный протокол HTTPS.

Протокол HTTP не рекомендуется использовать для удаленного доступа к системе Directum RX. Допускается только при работе в локальной сети компании для тестирования системы. В этом случае данные от клиентского приложения к веб-серверу передаются по сети в открытом виде.

HTTP-порт. Порт для работы с системой по протоколу HTTP. Значение по умолчанию 80.

HTTPS-порт. Порт для работы с системой по протоколу HTTPS. Значение по умолчанию 443. Поле активно, если в поле Протокол указано значение https.

Путь до сертификата, расположенного на сервере, в формате PEM. Сертификат должен подходить для указанного имени сайта и содержать цепочку сертификатов. Подробнее см. раздел «Установка SSL-сертификата». Поле активно, если в поле Протокол указано значение https.

10.Укажите настройки базы данных и сервисов:

ВАЖНО. При установке системы в качестве адреса нельзя использовать localhost и 127.0.0.1, потому что в этом случае docker-контейнеры подключаются не к серверу, а к самим себе. В результате может возникнуть ошибка. Вместо этого укажите DNS-имя сервера или IP-адрес.

Тип СУБД, которая используется для хранения данных системы Directum RX. Возможные значения: PostrgreSQL – PostgreSQL/Postgres Pro/Jatoba/Tantor, Microsoft SQL – Microsoft SQL Server. При установке системы в Linux рекомендуется использовать СУБД на основе PostgreSQL.

Выберите вариант развертывания базы данных:

•если БД была создана ранее, снимите флажок Создать новую базу. По умолчанию флажок установлен;

•если нужно создать новую БД, оставьте флажок Создать новую базу установленным.

В поле Сервер БД укажите параметры подключения к новой базе данных PostgeSQL:

•Сервер. Имя экземпляра СУБД, на котором будет развернута база данных системы Directum RX;

•Порт для работы с СУБД на основе PostgreSQL. Параметр задается, если в поле Тип СУБД выбрано значение PostgreSQL;

•База данных системы Directum RX;

•Пользователь сервера БД. Используется для взаимодействия системы с базой данных. Пользователю достаточно входить в роль  с атрибутом login. В этом случае пользователю, от которого система взаимодействует с базой данных, недоступны другие базы сервера БД;

•Пароль пользователя сервера БД. Использование пустого пароля не допускается;

•Администратор. Пользователь сервера БД с правами администратора. Используется только при создании базы данных во время установки системы. Права администратора есть у пользователей, которые на сервере БД включены в роль с атрибутом superuser. Для повышения информационной безопасности не рекомендуется указывать системного пользователя postgres.

Параметр Администратор необязательный. Если в параметре Администратор значение не указано, то в параметре Пользователь нужно указать пользователя с правами администратора сервера БД.

СОВЕТ. Чтобы обезопасить данные, рекомендуется указывать обоих пользователей. Если система Directum RX будет скомпрометирована, то злоумышленник не получит доступ к другим базам на сервере.

•Пароль администратора сервера БД. Заполните параметр, если указано значение в параметре Администратор.

ПРИМЕЧАНИЕ. Параметры подключения к базе данных Microsoft SQL Server см. в инструкции по установке системы в Microsoft Windows.

Сервер RabbitMQ. Заполните параметры подключения:

•Сервер. IP-адрес сервера, на котором установлен RabbitMQ;

ВАЖНО. Если RabbitMQ установлен на текущем сервере, в качестве адреса нельзя использовать значение 127.0.01. Вместо этого укажите внешний IP-адрес сервера.

•Порт, по которому RabbitMQ взаимодействует с веб-сервером, например 5672;

•Виртуальный хост RabbitMQ, например rxhost. Создается на этапе установки RabbitMQ. По умолчанию /. Чтобы ввести новое имя виртуального хоста, очистите символ /, а затем укажите новое значение;

•Пользователь, Пароль. Имя и пароль пользователя для подключения к RabbitMQ. Пользователь создается на этапе установки RabbitMQ;

•Точка обмена, к которой привязываются очереди сообщений веб-сервера. Также используется для наименования очередей сообщений. Укажите произвольное имя для новой точки обмена, например RxExchange. Она создастся во время установки системы.

ВАЖНО. Необходимо задать новую точку обмена. Если указать точку обмена, которая по умолчанию уже есть в RabbitMQ, при установке системы может возникнуть ошибка.

Сервер MongoDB. В строке подключения задаются:

•Сервер. IP-адрес сервера, на котором установлена СУБД MongoDB.

ВАЖНО. Если MongoDB установлена на текущем сервере, в качестве адреса нельзя использовать значение 127.0.01. Вместо этого укажите внешний IP-адрес сервера.

•Порт, по которому MongoDB взаимодействует с сервисами Directum RX. Значение по умолчанию 27017;

•Пользователь, Пароль. Имя и пароль пользователя для подключения к MongoDB. Пользователь создается на этапе установки MongoDB.

ВАЖНО. Для значений параметров MongoDB учитывается регистр символов.

При заполнении полей Сервер БД, Сервер RabbitMQ и Сервер MongoDB по кнопке можно переключиться на настройку параметров в виде строки подключения. Подробнее см. в руководстве администратора, раздел «Минимальные настройки».

Папка с данными. Укажите путь к локальной папке. Папка создастся автоматически во время установки системы. В ней будут созданы подпапки для хранения содержимого документов, файлов предпросмотра, лог-файлов системы и других данных.

Пароль, который будет задан для служебных пользователей: Administrator, Service User, Integration Service и Adviser. В поле ниже повторите пароль.

СОВЕТ. Рекомендуется использовать пароль, который состоит из 8 и более символов, содержит строчные и прописные буквы, а также цифры. Это повышает стойкость пароля ко взлому. Если пароль не соответствует рекомендациям, появляется значок предупреждения. При наведении курсора на него отображается подсказка:

С помощью значка можно показать пароль.

11.Укажите дополнительные настройки:

Код системы, который используется в работе сервисов Directum RX и в штрихкодах документов, чтобы различать штрихкоды разных систем. Параметр должен быть уникальным для каждой новой установленной системы Directum RX. Для продуктивной системы код передается в письме при поставке.

Язык системы. Возможные значения: Русский, Английский. На выбранном языке будут отображаться наименования шаблонов и видов документов, тексты задач и заданий по умолчанию, а также другие автоматически создаваемые данные.

При этом язык интерфейса веб-клиента Directum RX по умолчанию будет таким же, как и в операционной системе. Пользователи могут изменить язык интерфейса в проводнике Directum RX.

Данные в системе отображаются на том языке, на котором их занесли в систему. Их можно заносить на любом языке и любыми символами, независимо от основного языка системы. Все данные хранятся в кодировке Unicode.

ВАЖНО. Язык системы можно задать только во время установки Directum RX, в дальнейшем его изменять нельзя.

12.При первой установке системы убедитесь, что установлен флажок DirectumRX и заполнено поле Путь до пакета. Флажок и поле доступны, если в корне локальной папки с Directum Launcher есть архив DirectumRX.tar.gz.

Если разработка состоит из нескольких пакетов или нужно опубликовать пакет другого решения, то нажмите на кнопку и в появившемся поле укажите путь до пакета:

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

Примечание. Если в строке подключения указана существующая база данных Directum RX с прикладной разработкой, то снимите флажок DirectumRX.

13.Если планируется использовать мобильные приложения Directum Solo и Directum Jazz, убедитесь, что установлен флажок NOMAD. Выполните шаги по установке сервиса NOMAD. Снимите флажок, если мобильные решения не используются.

14.Для установки справки убедитесь, что стоит флажок WebHelp. Флажок можно снять, например, если система устанавливается для тестирования и нужно сэкономить место на диске.

15.Ознакомьтесь с текстом лицензионного соглашения и установите флажок Я принимаю условия лицензионного соглашения.

16.Нажмите на кнопку Установить. При этом сгенерируется конфигурационный файл config.yml, выполнится проверка подключения к СУБД, RabbitMQ и MongoDB. Неверно заполненные поля подсветятся красным цветом.

17.Дождитесь окончания установки. На странице выводятся этапы установки. В раскрывающейся области с названием этапа отображаются сообщения из лог-файла установки.

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

Если нужно изменить ранее заданные настройки, нажмите на кнопку Вернуться к настройкам. В результате откроется страница установки. Укажите новые значения параметров и повторно нажмите на кнопку Установить.

Когда установка завершится, на странице появится ссылка для входа в веб-клиент.

18.Если служба Docker запускается от учетной записи без привилегий суперпользователя (в режиме Rootless), то:

•проверьте, что для этой учетной записи выданы полные права на файлы сертификатов. Например, права на SSL-сертификат, сертификаты сервиса ключей, промежуточные и другие сертификаты, использующиеся для работы в Directum RX. Список установленных сертификатов можно посмотреть с помощью утилиты certificate-tool. Также выдайте права на чтение и запись в папки, в которых находятся папки с лог-файлами и со статус-файлами, права на чтение и запись в папку сервиса хранилищ, сервиса хранения файлов предпросмотра и другие папки, путь до которых задается в конфигурационном файле config.yml;

•для дополнительной безопасности можно настроить запуск служб внутри контейнеров от учетных записей без привилегий суперпользователя. Для этого в Directum Launcher во встроенном редакторе YAML добавьте параметр CONTAINER_BUILD_ARG.

19.Далее продолжите действия по установке и настройке Directum RX.

Справочная информация

Во время установки в папке DirectumLauncher/etc автоматически создается конфигурационный файл config.yml с заполненными параметрами. Соответствие полей в Directum Launcher и параметров конфигурационного файла:

© Компания Directum, 2024