<< Click to Display Table of Contents >> Конфигурирование настроек |
Настройки системы Directum RX задаются в конфигураторе. После применения настройки преобразуются в формат YAML и сохраняются в конфигурационном файле config.yml. На основе этого файла генерируются XML-файлы с настройками для каждого компонента при его развертывании.
Настройки можно конфигурировать через:
•инструмент Directum Launcher в визуальном конфигураторе (рекомендуется) или во встроенном редакторе YAML;
•конфигурационный файл config.yml.
ВАЖНО. Изменять настройки системы рекомендуется в нерабочее время, чтобы не помешать работе сотрудников.
У системы есть минимально необходимые настройки, которые задаются в Directum Launcher при установке или обновлении системы. Остальные настройки, необходимые для работы системы, генерируются со значениями по умолчанию.
ВАЖНО. Не изменяйте настройки напрямую в XML-файлах, то в дальнейшем они затрутся настройками из config.yml.
В комплект поставки Directum RX входит пример конфигурационного файла full_config.yml.example с примерами настроек параметров. Путь до файла: DirectumLauncher/etc/_builds/Platform/platform_plugin/full_config.yml.example.
Полный набор параметров можно посмотреть в конфигурационных файлах сервисов _ConfigSettings.xml.example. Путь до файла: DirectumLauncher/etc/_builds/Platform/<Имя сервиса>/<Имя сервиса>.zip/_ConfigSettings.xml.example. Примеры настроек, которые часто используются на практике, приведены в следующих разделах.
Соответствие настроек конфигуратора и секций config.yml
Секции в конфигураторе соответствуют секциям конфигурационного файла config.yml:
Секция Directum Launcher |
Секция config.yml |
---|---|
Переменные |
variables |
Логирование |
logs_path |
Общие настройки |
common_config |
Настройки сервисов |
services_config |
Далее в разделах названия секций конфигурационного файла указываются в скобках.
В секции Общие настройки (common_config) задаются общие настройки для всех сервисов. Например, туда вынесены строки подключения к базе данных и RabbitMQ.
Путь до лог-файлов всех сервисов задается в секции Логирование. Если нужно изменить путь к лог-файлам конкретного сервиса, во встроенном редакторе в секции сервиса добавьте параметр LOGS_PATH и укажите новый путь.
В секции Настройки сервисов (services_config) задаются уникальные настройки сервисов и утилит.
Соответствие секций конфигуратора и секций конфигурационного файла:
Компонент |
Секция с настройками |
---|---|
SungeroWebClient |
|
SungeroWebServer |
|
GenericService |
|
WorkflowProcessService |
|
WorkflowBlockService |
|
PreviewService |
|
PreviewStorage |
|
JobScheduler |
|
SungeroWorker |
|
StorageService |
|
IndexingService |
|
InitialIndexing |
|
DelayedOperationsService |
|
ClientsConnectionService |
|
IntegrationService |
|
ReportService |
|
SungeroWidgets |
|
LogService |
|
KeyDerivationService |
|
SungeroCentrifugo |
|
DeploymentTool |
|
RxCmd |
|
SungeroRabbitMQ |
|
SungeroMongodb |
|
SungeroHaproxy |
|
NomadService |
Формат настроек в конфигурационном файле
Настройки, заданные в конфигураторе, приводятся к формату YAML и сохраняются в конфигурационном файле config.yml.
Формат строки:
<Параметр>: '<Значение>'
Параметры, содержащие несколько значений, задаются в виде структуры. Например, так задается тема проводника веб-клиента:
CUSTOM_THEMES_CSS:
theme:
- '@cssPath': '{{ home_path }}/custom/custom-theme.css'
- '@cssPath': '{{ home_path }}/custom/custom-theme-night.css'
Чтобы использовать одинаковые значения в параметрах, задавайте переменные в секции variables конфигурационного файла. Достаточно один раз указать значение в переменной, в остальных параметрах оно подхватится автоматически. При необходимости можно добавить свои переменные.
Например, в переменной home_path указан путь, по которому хранятся данные сервисов. Далее переменная используется для настройки папки с лог-файлами и других путей:
home_path: '/srv'
LOGS_PATH: '{{ home_path }}/logs'
Подробнее о формате YAML см. на сайте The Official YAML Web Site.
Передача данных между контейнерами и локальным компьютером
Особенность файловой системы Docker в том, что папки контейнера доступны только внутри него. Если нескольким контейнерам нужно обращаться к одним и тем же данным или нужно передать данные с локального компьютера в контейнер, в конфигурационном файле config.yml в секции variables заполните переменные:
•volume_dir – папки для обмена данными (volume) с доступом только на чтение. Если не указан путь внутри контейнера, то папка доступна по пути по умолчанию: /mnt/volume_dir;
•volume_dir_rw – папки для обмена данными (volume) с доступом на чтение и запись. Если путь внутри контейнера не указан, то папка доступна по пути по умолчанию: /mnt/volume_dir_rw.
ПРИМЕЧАНИЕ. Если в переменных volume_dir и volume_dir_rw указана одна и та же папка, то она доступна на чтение и запись.
Папки для обмена данными (volume) задаются на локальном компьютере. Они пробрасываются во все контейнеры с сервисами. Внутри контейнера доступны по заданному пути. Подробнее см. в документации Docker, в статье Use volumes.
Пример настройки:
variables:
volume_dir:
- '{{ home_path }}/volume:/container/volume'
- '{{ home_path }}/second_volume:/container/second_volume'
volume_dir_rw:
- '{{ home_path }}/volume_rw:/container/volume_rw'
- '{{ home_path }}/second_volume_rw:/container/second_volume_rw'
Настройки средств ввода и интеллектуальной обработки документов
•настройки службы ввода документов задаются в конфигурационном файле appsettings.json. Расположение файла зависит от способа установки службы;
•настройки Directum Ario задаются в конфигурационном файле .env.
© Компания Directum, 2024 |