Развертывание сервиса синхронизации почты через
Docker
Средний
Инструкция применима для сервиса синхронизации почты версии 1.0.0.
Инструкция подходит для развертывания в своем окружении, соответствующем системным требованиям BPMSoft. При развертывании BPMSoft в инфраструктуре других облачных провайдеров необходимо учитывать особенности и возможные ограничения инфраструктуры и предоставляемых доступов. Для уточнения деталей или при возникновении вопросов рекомендуем обратиться к документации или поддержке облачного провайдера.
Подготовка к развертыванию
Перед установкой сервиса синхронизации почты выполните следующее:
- Для предоставления доступа к архиву с файлами для развертывания обратитесь в Техническую поддержку BPMSoft.
- Перед установкой убедитесь в том, что среда, на которую вы хотите устанавливать сервис, соответствует системным требованиям.
- Для работы установите Docker Desktop версии 4.3.0 и выше.
- Если необходима синхронизация активностей и контактов с MS Exchange, то при развертывании BPMSoft нужно установить пакет gss-ntlmssp. Подробнее: Настройка сервера системы на Linux.
Микросервис рекомендуется развертывать на выделенной виртуальной машине, недоступной из внешней сети. Следует открыть только порты, необходимые для взаимодействия с основным приложением, и разрешить подключения к ним только с IP-адресов серверов основного приложения.
Развертывание сервиса синхронизации почты
Для запуска сервиса необходимо:
- На компьютере с Linux или в WSL2 (для Windows) создайте папку для файлов Docker Compose, связанных с сервисом синхронизации почты.
sudo mkdir /usr/el
- Переместите файл docker-compose в домашнюю директорию пользователя (~), используя Linux или WSL2 (для Windows).
- Скопируйте и разархивируйте файлы docker-compose в созданную директорию. Замените
на соответствующую версию релиза.
sudo cp ~/el--docker.zip /usr/el && cd /usr/el && sudo unzip el- -docker.zip
- Откройте папку src, где хранятся файлы docker-compose.
cd src
- Для запуска инфраструктуры сервиса синхронизации почты выполните следующую команду:
sudo docker compose -f docker-compose.infr.yaml up -d
Важно сначала запустить инфраструктуру, так как в этот момент создается сеть, которая связывает инфраструктурные сервисы и сервис синхронизации почты.
- Перед запуском компонент сервиса синхронизации почты проверьте и, при необходимости, настройте переменные окружения в файле .env:
- DOCKER_TAG указывает версию ExchangeListener;
- DOCKER_REPO определяет репозиторий, откуда Docker будет скачивать образы сервисов ExchangeListener. По умолчанию используется bpmsoft на docker.io (т. е. DOCKER_REPO=bpmsoft). Измените это значение, если используете собственный прокси-репозиторий в закрытых сетях без доступа в сеть Интернет, например: DOCKER_REPO=bpmsoft-docker-repo.company.ru/bpmsoft/el.
- Установите сервис:
docker compose up -d
Проверка состояния сервиса после развертывания
Для первичной проверки работоспособности сервиса после развертывания необходимо выполнить следующие шаги:
- Проверить доступность развернутых docker-контейнеров (должны находиться в статусе "Up") с помощью команды:
docker ps -a --filter "name=listener"
- С помощью команды "docker logs" проверить логи экземпляра компонента EL API на предмет отсутствия в них ошибок с помощью команды:
docker logs
- С сервера приложения BPMSoft выполнить запрос для проверки доступности сервиса синхронизации почты:
curl {адрес_сервиса}:{порт}/api/listeners/status -v
где:
- {адрес_сервиса} — URL-адрес развернутого сервиса;
- {порт} — порт, который использовался при развертывании сервиса.
Настройка на стороне BPMSoft
Для настройки сервиса в приложении BPMSoft необходимо установить корректные значения системных настроек в дизайнере системы:
Таблица 1 — Изменяемые системные настройки
| Название | Код | Формат значения настройки |
| ExchangeListenerServiceUri | ExchangeListenerServiceUri | [адрес развернутого ранее сервиса Exchange Listener]/api/listeners |
| URL сервиса обработки событий Exchange в BPMSoft | BpmCrmExchangeEventsEndpointUrl |
[адрес анонимного сервиса ExchangeListenerService]/NewEmail
Например:
|
Порты почтового сервера
По умолчанию на стороне почтового сервера используются порты, указанные в таблице 2.
Таблица 2 — Порты почтового сервера
| Номер порта | Протокол | Назначение |
| 443 | HTTPS | Для связи с Microsoft Exchange (EWS) |
|
587 465 |
SMTP | Для отправки писем |
| 993 | IMAP | Для получения почты через IMAP |
| 25 465 | SMTP | Для дополнительных потребностей отправки почты |
Убедитесь, что на ваших серверах используются указанные порты, и откройте их для работы сервиса синхронизации почты с почтовым сервером.
Рекомендуем изучить
Сервис синхронизации почты
Диагностика сервиса синхронизации почты
Общие принципы работы c email-сообщениями
Настройка почтового ящика
Материал был полезен для вас?