IVA ДОКУМЕНТАЦИЯ
ОБНОВЛЕНИЯ

Модуль Менеджер плагинов

Модуль Менеджер плагинов предназначен для подключения, запуска и управления внешними плагинами IVA Mail.

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

О подключении средств антивирусной защиты и защиты от спама см. Антивирусная защита и защита от спама.

Добавление плагинов поддерживается только на серверах под управлением Linux.

Модуль поддерживает:

  • добавление плагинов;

  • настройку параметров запуска;

  • управление автозапуском;

  • изменение уровня журналирования;

  • запуск и остановку плагинов;

  • удаление подключённых плагинов.

Как работает плагин

Плагин — отдельная программа, которая устанавливается на сервер IVA Mail и может быть написана на любом языке программирования. Сервер сам запускает и останавливает плагин: по кнопкам Запустить и Остановить или автоматически при старте сервера, если включён Автостарт. Рабочий каталог плагина — рабочий каталог сервера, как правило /var/ivamail.

Сервер обменивается с плагином данными по протоколу, который соответствует типу плагина: Scanner — проверка писем и файлов, Authenticator — проверка учётных данных.

Расположение в интерфейсе

Модули → Менеджер плагинов

Основные параметры

Параметр Описание

Уровень журнала

Определяет детализацию журнала событий для модуля Менеджер плагинов.

Имя плагина

Задаёт отображаемое имя подключаемого плагина.

Тип плагина

Определяет тип подключаемого плагина:

  • Scanner — плагины проверки писем и загружаемых файлов, например антивирус или антиспам. Проверка писем запускается действием Сканировать Плагином в почтовом правиле (см. Антивирусная защита и защита от спама);

  • Extension — расширения, которые добавляют серверу дополнительные функции и интеграции;

  • Authenticator — плагины проверки учётных данных пользователей во внешней системе (см. Плагины аутентификации).

Автостарт

Определяет, будет ли плагин автоматически запускаться при старте служб IVA Mail.

Уровень журнала плагина

Определяет детализацию журнала событий конкретного плагина.

Путь к плагину

Указывает путь к исполняемому файлу или каталогу плагина на сервере.

Статус

Показывает текущее состояние плагина: запущен или остановлен.
После изменения параметров необходимо нажать Модифицировать или выполнить запуск плагина, чтобы изменения применились.

Управление плагинами

В нижней части страницы отображается список подключённых плагинов.

Для каждого плагина доступны действия:

  • Запустить/Остановить — запускает или останавливает выбранный плагин;

  • Удалить плагин — удаляет плагин из конфигурации сервера.

Также отображаются:

  • состояние автозапуска;

  • уровень журналирования;

  • путь к плагину;

  • текущий статус работы.

Плагины аутентификации

Плагин типа Authenticator проверяет учётные данные пользователя во внешней системе, например в LDAP-каталоге. Сервер передаёт плагину имя пользователя и пароль, а плагин отвечает, верны ли учётные данные.

Плагин используется для аккаунтов, у которых:

  • включена внешняя аутентификация (настройка аккаунта ExternalAuth = true);

  • в параметре Плагин аутентификации указано имя плагина (настройка аккаунта ExternalAuther).

Параметры задаются в карточке аккаунта в блоке Внешняя аутентификация. Как и другие настройки аккаунта, их можно задать в умолчаниях для аккаунтов домена или сервера (см. Архитектура и наследование настроек).

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

ObjectSetSetting "example.ru" "user" "ExternalAuth" true
ObjectSetSetting "example.ru" "user" "ExternalAuther" "<имя_плагина>"

Диагностика

  • Сообщения плагина записываются в журнал сервера. Детализация зависит от параметра Уровень журнала плагина: на время настройки рекомендуется установить Отладочный. Журналы сервера описаны в разделе Мониторинг и диагностика.

  • После запуска сервер согласует с плагином тип и версию протокола. Если тип, выбранный при добавлении плагина, не совпадает с типом, который реализует программа (например, антивирус добавлен с типом Authenticator), сервер останавливает плагин и не использует его. В этом случае проверьте параметр Тип плагина и статус плагина.

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

CLI

Для управления плагинами используются команды:

Команда Назначение

PluginList

Получение списка плагинов с настройками и статусом.

PluginAdd

Добавление плагина.

PluginDel

Удаление плагина.

PluginStart

Запуск плагина.

PluginStop

Остановка плагина.

Подробнее в разделе Справочник команд CLI.