Конфигурационный файл модуля /opt/rubackup/etc/rb_module_vk_workmail.conf

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

Таблица 1. Параметры конфигурационного файла /opt/rubackup/etc/rb_module_vk_workmail.conf
Параметр Описание

url

Комбинация IP-адреса или имени узла с портом для подключения модуля к сервисам почтовой системы.

По умолчанию

<address:port>

token

Токен учетной записи для авторизации в сервисах.

По умолчанию

<token>

max_message_size

Максимальный размер сообщения, который может быть принят или отправлен (в байтах).

По умолчанию

100000000

keepalive_time_ms

Период отправки keepalive-запроса почтовой системе, позволяющий поддерживать соединение в активном состоянии (в миллисекундах).

Возможные значения

Целое положительное число.

По умолчанию

10000

keepalive_timeout_ms

Время ожидания ответа на keepalive-запрос от почтовой системы (в миллисекундах).

Возможные значения

Целое положительное число.

По умолчанию

5000

Если по истечении указанного времени ответ на запрос не был получен, то связь модуля с почтовой системой прерывается

force_unique_channel_target

Возможность принудительно открывать отдельную TCP-сессию для каждого созданного канала.

Возможные значения

true, false.

По умолчанию

true

additional_args

Дополнительные параметры для канала gRPC.

Задается в виде списка пар (ключ=значение), разделенных точкой с запятой. Ключи соответствуют именам аргументов канала gRPC.

Пример 1. Параметры канала gRPC
additional_args    grpc.keepalive_time_ms=10000;grpc.keepalive_timeout_ms=5000

size_threshold

Размер (в байтах) бинарного файла, в который происходит сохранение писем пользователей почтовой системы.

По умолчанию

200000000.

Если размер файла превышает указанное значение, то для записи следующих данных будет создан новый файл

threads_number

Количество потоков для передачи данных между почтовой системой и СРК RuBackup при резервном копировании и восстановлении данных.

По умолчанию

4

left_bound_of_emails

right_bound_of_emails

Левая и правая границы диапазона почтовых ящиков, подлежащих резервному копированию.

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

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

  • left_bound_of_emails ≤ email < right_bound_of_emails (если указаны обе границы);

  • left_bound_of_emails ≤ email (если указана только левая граница);

  • email < right_bound_of_emails (указана только правая граница).

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

Пример 2. Задание обеих границ диапазона почтовых ящиков
left_bound_of_emails   abc
right_bound_of_emails  z

В диапазон попадут ящики abc@domain.ru, yellow@domain.ru, support@domain.ru и т.д.

В диапазон не попадут ящики 1abc@domain.ru, zzz@domain.ru и т.д.

При изменении диапазона все задачи на создание резервных копий с прежними значениями будут завершены с ошибкой.

auto_switch_full

Автоматически переключать на полное резервное копирование, если произошла ошибка выполнения инкрементального резервного копирования.

Возможные значения

yes, no.

По умолчанию

yes

allow_work_with_incompatible_version

Разрешить модулю работать с неподдерживаемой версией почтовой системы.

Модуль отправляет запрос почтовой системе для определения её версии, если версия почтовой системы отличается от списка версий, с которыми взаимодействует модуль, то при значении:

yes

Резервное копирование и восстановление РК будет продолжено. В журнал модуля будет добавлена запись о неподдерживаемой версии почтовой системы [1].

no

Резервное копирование и восстановление РК будет недоступно.

По умолчанию

no

1. За взаимодействие модуля с с неподдерживаемой версией почтовой системы компания RuBackup ответственности не несет.
Пример 3. Конфигурационный файл /opt/rubackup/etc/rb_module_vk_workmail.conf
### Mandatory options ###

# Combination of address/hostname + port for connection to WorkMail backup 
# services
url             <address:port>

# Token for authorization in WorkMail backup services
token           <token>

# Maximum receive and send grpc message size (bytes)
max_message_size 100000000

# Keepalive ping sending interval in milliseconds
# Possible values: > 0
# Default value: 10000
#keepalive_time_ms     10000

# Timeout for waiting for a response to a keepalive ping in milliseconds
# Possible values: > 0
# Default value: 5000
#keepalive_timeout_ms  5000

# Force opening a separate TCP session for each created channel
# Possible values: true, t, yes, y (case-insensitive)
# any other value is treated as false
# Default value: true
#force_unique_channel_target true

# Additional arguments for the gRPC channel
# Format: semicolon-separated list of key=value pairs 
# (e.g., "key1=value1;key2=value2")
# Keys correspond to gRPC channel argument names (see gRPC documentation).
# Values can be integers (for int arguments) or strings 
# (for string arguments).
# Boolean arguments should be specified as 0/1.
# Default: empty (no additional arguments)
# Examples:
# additional_args grpc.keepalive_time_ms=10000;grpc.keepalive_timeout_ms=5000
# additional_args grpc.max_send_message_length=-1;grpc.max_receive_message_length=4194304
# additional_args grpc.http2.max_pings_without_data=0;grpc.http2.min_time_between_pings_ms=10000
#additional_args

# Size threshold in bytes per segment. 
# Rotation occurs after this limit is exceeded.
# Default: 200000000 (200 MB).
#size_threshold    200000000

# Number of worker threads (default is 4). 
# The number can't be negative or be equal to 0.
threads_number         4

# Bounds of emails names. If not set, will use all data
#left_bound_of_emails
#right_bound_of_emails

# Whether to switch to a full backup if incremental/differential 
# cannot be performed.
#auto_switch_full yes

# Try using the module if the platform version is not compatible 
# with RuBackup. Optional. Default: no
allow_work_with_incompatible_versions no