sympa

Это роль Ansible, которая настраивает менеджер рассылок Sympa.

Требования

Debian stretch или сервер Ubuntu. Возможности баз данных MySQL/MariaDB или PostgreSQL. Менеджер базы данных может быть уже установлен на хосте (по умолчанию) или дополнительно установлен этой ролью. Вебсервер для Sympa должен быть настроен отдельно.

Переменные роли

Полная документация доступна по адресу https://sympa-community.github.io/. Эта роль была протестирована с Sympa версии 6.2.16 (пакет sympa для Debian stretch).

Шаблоны списков

sympa_template_lists — это список шаблонов, которые нужно определить. Содержимое можно найти в документации по шаблонам списка Sympa. Каждый элемент состоит из следующих атрибутов и приведет к созданию папки, содержащей comment.tt2 и config.tt2, которая будет создана в /etc/sympa/create_list_templates/ с атрибутом name в качестве имени папки:

Имя	Обязательное/По умолчанию	Описание
`name`	:heavy_check_mark:	Имя папки для шаблона
`config`	:heavy_check_mark:	Содержимое, которое будет записано в файл `config.tt2`
`comment`	:heavy_check_mark:	Содержимое, которое будет записано в файл `comment.tt2`

Источники данных

sympa_data_sources — это список источников данных для определения. Содержимое можно найти в документации по источникам данных Sympa. Каждый элемент состоит из следующих атрибутов и приведет к созданию файла с окончанием incl в /etc/sympa/data_sources/:

Имя	Обязательное/По умолчанию	Описание
`name`	:heavy_check_mark:	Имя файла для источника данных
`content`	:heavy_check_mark:	Содержимое, которое будет записано в файл источника данных

Менеджер алиасов

sympa_alias_manager — это путь к исполняемому файлу менеджера алиасов. Если переменная sympa_ldap_alias_entry определена, она будет записана в /etc/sympa/ldap_alias_entry.tt2. Если переменная sympa_ldap_alias_manager_conf определена, она будет записана в /etc/sympa/ldap_alias_manager.conf и может содержать следующие значения:

Имя	Обязательное/По умолчанию	Описание
`host`	:heavy_check_mark:	URL хоста LDAP-сервера.
`bind_dn`	:heavy_check_mark:	DN пользователя для подключения.
`bind_pwd`	:heavy_check_mark:	Пароль пользователя.
`base_dn`	:heavy_check_mark:	Базовый DN LDAP-дерева.
`mail_attribute`	`mailRoutingAddress`	Атрибут, используемый для записи.
`ssl`	`false`	Включение или отключение SSL
`queue_transport`	`sympa`	Название обычного транспорта.
`bouncequeue_transport`	`sympabounce`	Название транспорта при возврате почты.

Переменные аутентификации

sympa_auth — это список методов аутентификации, используемых в порядке. Каждый элемент состоит из следующих атрибутов:

Имя	Обязательное/По умолчанию	Описание
`name`	:heavy_check_mark:	Имя опции аутентификации, например, ldap, user_table
`options`	:heavy_check_mark:	Словарь опций для метода аутентификации

Пример

sympa_auth:
- name: ldap
  options:
    host: ldap.example.com:636
    timeout: 20
    suffix: yoursuffix
    bind_dn: yourbinddn
    bind_password: yourpw
    use_tls: ldaps
    ca_verify: none
    get_dn_by_uid_filter: "(uid=[sender])"
    email_attribute: mail
    scope: sub
    authentication_info_url: https://example.com
- name: user_table
  options:
    regexp: ".*"

Переменные тем

Список тем под ключом sympa_topics. Каждый элемент списка содержит следующие атрибуты:

Имя	Обязательное/По умолчанию	Описание
`path`	:heavy_check_mark:	Путь к категории
`title`	:heavy_check_mark:	Заголовок категории

Пример

sympa_topics:
- path: art
  title: Art
- path: art/expressionism
  title: Expressionism

Менеджер баз данных

Имя	Обязательное/По умолчанию	Описание
`sympa_db_type`	`mysql`	Выбор менеджера базы данных. `MySQL` или `Pg`. Значения `mysql` и `PostgreSQL` приемлемы. Другие варианты баз данных не поддерживаются.
`sympa_install_db_package`	`False`	Установлен ли менеджер базы данных ранее (`False`) или роль устанавливает его (`True`)

Переменные Sympa

Имя	Обязательное/По умолчанию	Описание
`sympa_domain`	`"{{ ansible_fqdn }}"`	Основной хост имени робота
`sympa_listmaster`	`listmaster@{{ sympa_domain }}`	Список адресов электронной почты для повышения до роли listmaster
`sympa_wwsympa_url`	:heavy_check_mark:	URL главной веб-страницы
`sympa_email`	:heavy_multiplication_x:	Локальная часть адреса электронной почты sympa
`sympa_db_password`	:heavy_check_mark:	Пароль для подключения к базе данных
`sympa_db_name`	`sympa`	Имя базы данных
`sympa_db_host`	`localhost`	Имя хоста сервера базы данных
`sympa_db_port`	`3306`	Порт сервера базы данных
`sympa_db_user`	`sympa`	Пользователь для подключения к базе данных
`sympa_lang`	`en`	Язык по умолчанию (один из поддерживаемых языков) #supported_lang ca,cs,de,el,es,et,en-US,fr,fi,hu,it,ja,ko,nl,nb,oc,pl,pt-BR,ru,sv,tr,vi,zh-CN,zh-TW
`sympa_logo_html_definition`	:heavy_multiplication_x:	HTML-фрагмент для размещения логотипа в верхнем левом углу
`sympa_gecos`	`SYMPA`	Gecos для служебной почты, отправленной самим Sympa.
`sympa_process_archive`	`False`	Хранить распределенные сообщения в архиве
`sympa_voot_feature`	`False`	Функция Voot
`sympa_max_wrong_password`	`19`	Количество неверных попыток ввода пароля
`sympa_static_content_path`	`/var/lib/sympa/static_content`	Директория для хранения статичных материалов
`sympa_static_content_url`	`/static-sympa`	URL, сопоставленный с директорией `sympa_static_content_path`
`sympa_syslog`	`LOCAL1`	Условия syslog для sympa
`sympa_log_level`	`0`	Вербosity журнала 0: нормально, 2,3,4: для отладки
`sympa_log_socket_type`	`unix`	Режим связи с syslogd (unix, inet)
`sympa_sendmail`	`/usr/bin/sendmail`	Путь к MTA (sendmail, postfix, exim или qmail) должен указывать на бинарный файл, совместимый с sendmail (например, бинарный файл с именем "sendmail" поставляется вместе с Postfix)
`sympa_maxsmtp`	`40`	Макс. количество процессов Sendmail (запускаемых Sympa), работающих
`sympa_log_smtp`	`False`
`sympa_use_blacklist`	`[ send, create_list ]`	Список операций, для которых применяется фильтр черного списка. Пустой список отключит эту функцию.
`sympa_max_size`	`5242880`	Максимальный размер (в байтах) для сообщений по умолчанию (можно переопределить для каждого списка)
`sympa_sendmail_nrcpt`	`25`	Максимальное количество получателей за один вызов Sendmail. Файл nrcpt_by_domain.conf позволяет другую настройку для каждой доменной получателя.
`sympa_sendmail_avg`	`10`	Максимальное количество разных доменов за один вызов Sendmail
`sympa_rfc2369_header_fields`	`[help, subscribe, unsubscribe, post, owner, archive ]`	Укажите, какие заголовки списков рассылки RFC2369 нужно добавить
`sympa_remove_headers`	[ `X-Sympa-To, X-Family-To, Return-Receipt-To, Precedence, X-Sequence, Disposition, Notification-To, Sender ]`	Укажите заголовочные поля, которые нужно удалить перед распределением сообщения
`sympa_reject_mail_from_automates_feature`	`True`	Отклонять почту от автоматов (crontab и т.д.), отправленную в список?
`sympa_packet_priority`	`5`	Приоритет по умолчанию для пакета, отправляемого массово.
`sympa_bulk_fork_threshold`	`1`	Минимальное количество пакетов в базе данных, прежде чем массовый процесс начнет увеличивать скорость отправления
`sympa_bulk_max_count`	`3`	Максимальное количество массовых процессов, которые будут запущены на одном сервере
`sympa_bulk_lazytime`	`600`	Количество секунд, в течение которых вспомогательный массовый процесс будет работать без обработки сообщения, прежде чем он спонтанно завершится.
`sympa_bulk_sleep`	`1`	Количество секунд, в течение которых массовый процесс будет спать между запуском нового цикла, если он не нашел сообщение для отправки.
`sympa_bulk_wait_to_fork`	`10`	Количество секунд, которые массовый процесс ждет между двумя проверками числа пакетов.
`sympa_default_max_list_members`	`0`	Ограничение по умолчанию для количества подписчиков в каждом списке (0 означает отсутствие ограничения)
`sympa_spool`	`/var/spool/sympa`	Директория, содержащая различные специализированные очереди
`sympa_queue`	`/var/spool/sympa/msg`	Директория для очереди входящих сообщений
`sympa_queuemod`	`/var/spool/sympa/moderation`	Директория для очереди модерации
`sympa_queuedigest`	`/var/spool/sympa/digest`	Директория для очереди дайджестов
`sympa_queueauth`	`/var/spool/sympa/auth`	Директория для очереди аутентификации
`sympa_queueoutgoing`	`/var/spool/sympa/outgoing`	Директория для архивной очереди
`sympa_queuesubscribe`	`/var/spool/sympa/subscribe`	Директория для очереди подписки
`sympa_queuetopic`	`/var/spool/sympa/topic`	Директория для очереди тем
`sympa_queuebounce`	`/var/spool/sympa/bounce`	Директория для входящей очереди возвратов
`sympa_queuetask`	`/var/spool/sympa/task`	Директория для очереди задач
`sympa_queueautomatic`	`/var/spool/sympa/automatic`	Директория для очереди автоматического создания списка
`sympa_queuebulk`	`/var/spool/sympa/bulk`	Директория для очереди исходящих сообщений
`sympa_viewmail_dir`	`/var/spool/sympa/viewmail`	Директория, содержащая HTML-файлы, созданные MHonArc во время отображения сообщений, кроме архивов
`sympa_welcome_return_path`	`owner`	Возвратный адрес приветственного сообщения (unique, owner). Если установлен на unique, новый подписчик будет удален, если приветственное сообщение вернется.
`sympa_remind_return_path`	`owner`	Возвратный адрес сообщения напоминания (unique, owner). Если установлен на unique, подписчик будет удален, если сообщение напоминания вернется, используйте с осторожностью.
`sympa_bounce_path`	`/var/lib/sympa/bounce`	Директория для хранения возвратов. Лучше, чтобы она не находилась в критической части.
`sympa_expire_bounce`	`daily`	Имя задачи для истечения срока действия старых возвратов
`sympa_bounce_warn_rate`	`30`	Темп возврата почты для предупреждения владельца списка
`sympa_bounce_halt_rate`	`50`	Темп возврата почты для приостановки списка (не реализовано)
`sympa_cache_list_config`	`none`	Использование двоичной версии структуры конфигурации списка на диске (none, binary_file)
`sympa_sympa_priority`	`1`	Приоритет команд Sympa
`sympa_request_priority`	`0`
`sympa_owner_priority`	`9`
`sympa_default_list_priority`	`5`	Приоритет по умолчанию для сообщений списка
`sympa_parsed_family_files`	`[message.footer, message.header, message.footer.mome, message.header.mime, info ]`	список файлов, которые будут обработаны Sympa при инициации семьи (пробелы не допускаются в именах файлов)
`sympa_dkim_feature`	`False`
`sympa_dkim_add_signature_to`	`[ robot, list ]`	Вставить DKIM-подпись в сообщение от робота, от списка или обоих
`sympa_dkim_signature_apply_on`	`[md5_authenticated_messages, smime_authenticated_messages, dkim_authenticated_messages, editor_validated_messages ]`	Тип сообщения, которому добавляется DKIM-подпись перед распределением среди подписчиков. Это список следующих ключевых слов: "md5_authenticated_messages", "smime_authenticated_messages", "dkim_authenticated_messages", "editor_validated_messages".
`sympa_dkim_private_key_path`	`/etc/ssl/dkim_private.key`	Местоположение файла, где хранится закрытый ключ DKIM
`sympa_dkim_signer_domain`	:heavy_multiplication_x:	Метка "d=", как определено в rfc 4871, по умолчанию — это имя домена виртуального хоста
`sympa_dkim_selector`	:heavy_multiplication_x:	Селектор
`sympa_dkim_signer_identity`	:heavy_multiplication_x:	Метка "i=", как определено в rfc 4871, по умолчанию равно null
`sympa_antivirus_path`	:heavy_multiplication_x:	Путь к движку антивирусного сканера, поддерживаемые антивирусы: Clam AntiVirus/clamscan & clamdscan, McAfee/uvscan, Fsecure/fsav, Sophos, AVP и Trend Micro/VirusWall
`sympa_antivirus_args`	:heavy_multiplication_x:	Аргумент команды плагина антивируса
`sympa_antispam_tag_header_name`	`X-Spam-Status`	Если фильтр спама (например, spamassassin или j-chkmail) добавляет заголовки smtp для пометки спамов, имя этого заголовка (например, X-Spam-Status)
`sympa_antispam_tag_header_spam_regexp`	:heavy_multiplication_x:	Регулярное выражение, применяемое к этому заголовку для проверки, является ли сообщение спамом (например, Yes)
`sympa_antispam_tag_header_ham_regexp`	:heavy_multiplication_x:	Регулярное выражение, применяемое к этому заголовку для проверки, не является ли сообщение спамом (например, No)
`sympa_spam_status`	:heavy_multiplication_x:	Сообщения должны быть отфильтрованы антисичай, который добавляет еще один заголовок к сообщениям. Этот параметр используется для выбора специального сценария для определения статуса спама сообщения: ham, spam или unsure. Этот параметр заменяет антисичай/@tag_header_name, антисичай/@tag_header_spam_regexp и антисичай/@tag_header_ham_regexp.
`sympa_arc_path`	`/var/lib/sympa/arc`	Директория для хранения HTML-архивов
`sympa_default_index`	`thrd`	Индекс по умолчанию для организации при входе в веб-архив: либо по темам, либо в хронологическом порядке
`sympa_cookie_expire`	`0`	Срок действия HTTP-куки
`sympa_cookie_domain`	`localhost`	Домен действительности HTTP-куки
`sympa_cookie_refresh`	`60`	Средний интервал для обновления идентификатора HTTP-сессии.
`sympa_custom_archiver`	:heavy_multiplication_x:	Активирует пользовательский архиватор для использования вместо MHonArc. Значение этого параметра - абсолютный путь в файловой системе к скрипту пользовательского архиватора.
`sympa_default_home`	`home`	Тип главной веб-страницы (списки, домашняя)
`sympa_edit_list`	`owner`
`sympa_ldap_force_canonical_email`	`1`	При использовании аутентификации LDAP, если идентификатор, предоставленный пользователем, был допустимым адресом электронной почты, если этот параметр установлен в false, то предоставленный адрес электронной почты будет использоваться для аутентификации пользователя. В противном случае используется первый адрес электронной почты, возвращенный сервером LDAP.
`sympa_review_page_size`	`25`	Количество строк по умолчанию в массиве, отображающем пользователей на странице проверки
`sympa_web_page_title`	`Служба списков рассылки`	Заголовок главной веб-страницы
`sympa_show_default_templates`	`false`	Показать или скрыть стандартные шаблоны списков
`sympa_template_lists`	`[]`	Список шаблонов для определения.
`sympa_data_sources`	`false`	Список источников данных для определения.
`sympa_alias_manager`	``	Путь к исполняемому файлу менеджера алиасов.
`sympa_ldap_alias_entry`	``	Многострочная строка, записанная в `/etc/sympa/ldap_alias_entry.tt2`.
`sympa_ldap_alias_manager_conf`	``	Словарь, содержащий атрибуты конфигурации менеджера алиасов
`sympa_auth`	`[{ name: "user:table", options: {regexp: ".*"}}]`	Список методов аутентификации, использованных в порядке.

Переменные роботов Sympa

sympa_robots — это список определений роботов Sympa, по умолчанию пустой. Каждый элемент содержит:

Имя	Обязательное/По умолчанию	Описание
`domain`	:heavy_check_mark:	Почтовой и веб- домен робота
`server_admin`	:heavy_check_mark:	Веб-сервер VHost admin
`listmaster`	:heavy_check_mark:	список почтовых адресов listamsters
`listmaster`	:heavy_check_mark:
`create_list`