udelarinterior.sympa

sympa

Ceci est un rôle Ansible qui met en place un gestionnaire de listes de diffusion Sympa.

Exigences

Serveur Debian stretch ou Ubuntu. Options de base de données MySQL/MariaDB ou PostgreSQL. Le gestionnaire de base de données peut être installé au préalable sur l'hôte (par défaut) ou optionnellement installé par le rôle lui-même. Le serveur web pour Sympa doit être configuré séparément.

Variables du rôle

Pour la documentation complète, consultez https://sympa-community.github.io/. Ce rôle a été testé avec la version 6.2.16 de Sympa (paquet sympa Debian).

Modèles de liste

sympa_template_lists est une liste de modèles à définir. Pour le contenu, voir la documentation des modèles de liste sympa. Chaque entrée se compose des éléments suivants et entraînera la création d'un dossier contenant comment.tt2 et config.tt2, qui sera créé dans /etc/sympa/create_list_templates/ avec l'attribut name comme nom du dossier :

Nom	Requis/Par défaut	Description
`name`	:heavy_check_mark:	Nom du dossier pour le modèle
`config`	:heavy_check_mark:	Contenu à écrire dans le fichier `config.tt2`
`comment`	:heavy_check_mark:	Contenu à écrire dans le fichier `comment.tt2`

Sources de données

sympa_data_sources est une liste de sources de données à définir. Pour le contenu, voir la documentation des sources de données sympa. Chaque entrée se compose des éléments suivants et entraînera la création d'un fichier avec l'extension incl dans /etc/sympa/data_sources/ :

Nom	Requis/Par défaut	Description
`name`	:heavy_check_mark:	Nom du fichier pour la source de données
`content`	:heavy_check_mark:	Contenu à écrire dans le fichier source de données

Gestionnaire d'alias

sympa_alias_manager est le chemin vers l'exécutable du gestionnaire d'alias. Si la variable sympa_ldap_alias_entry est définie, elle sera écrite dans /etc/sympa/ldap_alias_entry.tt2. Si la variable sympa_ldap_alias_manager_conf est définie, elle sera écrite dans /etc/sympa/ldap_alias_manager.conf et peut contenir les valeurs suivantes :

Nom	Requis/Par défaut	Description
`host`	:heavy_check_mark:	URL de l'hôte du serveur LDAP.
`bind_dn`	:heavy_check_mark:	bind dn de l'utilisateur à utiliser.
`bind_pwd`	:heavy_check_mark:	Mot de passe de l'utilisateur.
`base_dn`	:heavy_check_mark:	Base DN de l'arbre LDAP.
`mail_attribute`	`mailRoutingAddress`	Attribut utilisé pour écrire.
`ssl`	`false`	Activer ou désactiver ssl
`queue_transport`	`sympa`	Nom du transport normal.
`bouncequeue_transport`	`sympabounce`	Nom du transport lorsque un mail rebondit.

Variables d'authentification

sympa_auth est la liste des méthodes d'authentification utilisées dans l'ordre. Chaque entrée se compose des éléments suivants :

Nom	Requis/Par défaut	Description
`name`	:heavy_check_mark:	Nom de l'option d'authentification comme ldap, user_table
`options`	:heavy_check_mark:	Dictionnaire d'options pour la méthode d'authentification

Exemple

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: ".*"

Variables de sujet

Liste des sujets sous la clé sympa_topics. Chaque entrée de liste contient les éléments suivants :

Nom	Requis/Par défaut	Description
`path`	:heavy_check_mark:	Chemin de la catégorie
`title`	:heavy_check_mark:	Titre de la catégorie

Exemple

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

Gestionnaire de base de données

Nom	Requis/Par défaut	Description
`sympa_db_type`	`mysql`	Choix du gestionnaire de base de données. `MySQL` ou `Pg`. `mysql` et `PostgreSQL` sont acceptables. Les autres options de base de données ne sont pas gérées.
`sympa_install_db_package`	`False`	Indique si le gestionnaire de base de données est installé précédemment (`False`) ou si le rôle l'installe (`True`).

Variables Sympa

Nom	Requis/Par défaut	Description
`sympa_domain`	`"{{ ansible_fqdn }}"`	Nom d'hôte principal
`sympa_listmaster`	`listmaster@{{ sympa_domain }}`	Liste des adresses e-mail promues au rang de listmaster
`sympa_wwsympa_url`	:heavy_check_mark:	URL de la page web principale
`sympa_email`	:heavy_multiplication_x:	Partie locale de l'adresse e-mail de sympa
`sympa_db_password`	:heavy_check_mark:	Mot de passe pour la connexion à la base de données
`sympa_db_name`	`sympa`	Nom de la base de données
`sympa_db_host`	`localhost`	Nom d'hôte du serveur de base de données
`sympa_db_port`	`3306`	Port du serveur de base de données
`sympa_db_user`	`sympa`	Utilisateur pour la connexion à la base de données
`sympa_lang`	`en`	Langue par défaut (une des langues supportées)
`sympa_logo_html_definition`	:heavy_multiplication_x:	Extrait HTML pour placer le logo dans le coin supérieur gauche
`sympa_gecos`	`SYMPA`	Gecos pour le mail de service envoyé par Sympa lui-même.
`sympa_process_archive`	`False`	Stocker les messages distribués dans une archive
`sympa_voot_feature`	`False`	Fonction Voot
`sympa_max_wrong_password`	`19`	Nombre de tentatives de mot de passe incorrectes
`sympa_static_content_path`	`/var/lib/sympa/static_content`	Répertoire pour stocker le contenu statique
`sympa_static_content_url`	`/static-sympa`	URL mappée avec le répertoire `sympa_static_content_path`
`sympa_syslog`	`LOCAL1`	Installation syslog pour sympa
`sympa_log_level`	`0`	Verbosité des logs 0 : normal, 2,3,4 : pour débogage
`sympa_log_socket_type`	`unix`	Mode de communication avec syslogd (unix, inet)
`sympa_sendmail`	`/usr/bin/sendmail`	Chemin vers le MTA (sendmail, postfix, exim ou qmail) devrait pointer vers un binaire compatible sendmail (par exemple : un binaire nommé "sendmail" est distribué avec Postfix)
`sympa_maxsmtp`	`40`	Max. nombre de processus Sendmail (lancés par Sympa) en cours
`sympa_log_smtp`	`False`
`sympa_use_blacklist`	`[ send, create_list ]`	Liste des opérations pour lesquelles le filtre de liste noire est appliqué. Une liste vide désactivera la fonction.
`sympa_max_size`	`5242880`	Taille maximale par défaut (en octets) pour les messages (peut être redéfinie pour chaque liste)
`sympa_sendmail_nrcpt`	`25`	Nombre maximum de destinataires par appel à Sendmail. Le fichier nrcpt_by_domain.conf permet un réglage différent par domaine de destination.
`sympa_sendmail_avg`	`10`	Nombre maximum de domaines différents par appel à Sendmail
`sympa_rfc2369_header_fields`	`[help, subscribe, unsubscribe, post, owner, archive ]`	Spécifiez quels en-têtes de liste de diffusion rfc2369 ajouter
`sympa_remove_headers`	[ `X-Sympa-To, X-Family-To, Return-Receipt-To, Precedence, X-Sequence, Disposition, Notification-To, Sender ]`	Spécifiez les champs d'en-tête à supprimer avant la distribution de message
`sympa_reject_mail_from_automates_feature`	`True`	Rejeter les mails des automates (crontab, etc.) envoyés à une liste ?
`sympa_packet_priority`	`5`	Priorité par défaut pour un paquet à envoyer en masse.
`sympa_bulk_fork_threshold`	`1`	Nombre minimum de paquets dans la base de données avant que la masse se sépare pour augmenter le taux d'envoi
`sympa_bulk_max_count`	`3`	Nombre maximum de masses qui s'exécuteront sur le même serveur
`sympa_bulk_lazytime`	`600`	Le nombre de secondes pendant lesquelles une masse esclave restera en cours d'exécution sans traiter un message avant de mourir spontanément.
`sympa_bulk_sleep`	`1`	Le nombre de secondes qu'une masse attend entre le lancement d'une nouvelle boucle si elle n'a pas trouvé de message à envoyer.
`sympa_bulk_wait_to_fork`	`10`	Nombre de secondes qu'une masse maîtresse attend entre deux vérifications du nombre de paquets.
`sympa_default_max_list_members`	`0`	Limite par défaut pour le nombre d'abonnés par liste (0 signifie pas de limite)
`sympa_spool`	`/var/spool/sympa`	Répertoire contenant divers spools spécialisés
`sympa_queue`	`/var/spool/sympa/msg`	Répertoire pour le spool de messages entrants
`sympa_queuemod`	`/var/spool/sympa/moderation`	Répertoire pour le spool de modération
`sympa_queuedigest`	`/var/spool/sympa/digest`	Répertoire pour le spool de digest
`sympa_queueauth`	`/var/spool/sympa/auth`	Répertoire pour le spool d'authentification
`sympa_queueoutgoing`	`/var/spool/sympa/outgoing`	Répertoire pour le spool d'archive
`sympa_queuesubscribe`	`/var/spool/sympa/subscribe`	Répertoire pour le spool d'abonnement
`sympa_queuetopic`	`/var/spool/sympa/topic`	Répertoire pour le spool de sujet
`sympa_queuebounce`	`/var/spool/sympa/bounce`	Répertoire pour le spool de rebond entrants
`sympa_queuetask`	`/var/spool/sympa/task`	Répertoire pour le spool de tâches
`sympa_queueautomatic`	`/var/spool/sympa/automatic`	Répertoire pour le spool de création automatique de listes
`sympa_queuebulk`	`/var/spool/sympa/bulk`	Répertoire pour le spool sortant de messages
`sympa_viewmail_dir`	`/var/spool/sympa/viewmail`	Répertoire contenant le fichier HTML généré par MHonArc lors de l'affichage des messages autres que les archives
`sympa_welcome_return_path`	`owner`	Chemin de retour du message de bienvenue (unique, owner) Si défini sur unique, le nouvel abonné est supprimé si le message de bienvenue rebondit
`sympa_remind_return_path`	`owner`	Chemin de retour du message de rappel (unique, owner) Si défini sur unique, l'abonné est supprimé si le message de rappel rebondit, à utiliser avec précaution
`sympa_bounce_path`	`/var/lib/sympa/bounce`	Répertoire pour stocker les rebonds Mieux vaut ne pas être sur une partition critique
`sympa_expire_bounce`	`daily`	Nom de la tâche pour l'expiration des vieux rebonds
`sympa_bounce_warn_rate`	`30`	Taux d'e-mail de rebond pour avertir le propriétaire de la liste
`sympa_bounce_halt_rate`	`50`	Taux d'e-mail de rebond pour arrêter la liste (non implémenté)
`sympa_cache_list_config`	`none`	Utilisation de la version binaire de la structure de configuration de la liste sur disque (none, binary_file)
`sympa_sympa_priority`	`1`	Priorité des commandes Sympa
`sympa_request_priority`	`0`
`sympa_owner_priority`	`9`
`sympa_default_list_priority`	`5`	Priorité par défaut pour les messages de liste
`sympa_parsed_family_files`	`[message.footer, message.header, message.footer.mome, message.header.mime, info ]`	Liste des fichiers qui seront analysés par Sympa lors de l'instanciation d'une famille (aucun espace autorisé dans les noms de fichiers)
`sympa_dkim_feature`	`False`
`sympa_dkim_add_signature_to`	`[ robot, list ]`	Insérer une signature DKIM dans le message du robot, de la liste ou des deux
`sympa_dkim_signature_apply_on`	`[md5_authenticated_messages, smime_authenticated_messages, dkim_authenticated_messages, editor_validated_messages ]`	Type de message qui obtient une signature DKIM ajoutée avant distribution aux abonnés. C'est une liste des mots clés suivants : "md5_authenticated_messages", "smime_authenticated_messages", "dkim_authenticated_messages", "editor_validated_messages".
`sympa_dkim_private_key_path`	`/etc/ssl/dkim_private.key`	Emplacement du fichier où la clé privée DKIM est stockée
`sympa_dkim_signer_domain`	:heavy_multiplication_x:	Le tag "d=" comme défini dans la rfc 4871, par défaut est le nom de domaine de l'hôte virtuel
`sympa_dkim_selector`	:heavy_multiplication_x:	Le sélecteur
`sympa_dkim_signer_identity`	:heavy_multiplication_x:	Le tag "i=" comme défini dans la rfc 4871, par défaut est nul
`sympa_antivirus_path`	:heavy_multiplication_x:	Chemin vers le moteur de scanner antivirus antivirus supportés : Clam AntiVirus/clamscan & clamdscan, McAfee/uvscan, Fsecure/fsav, Sophos, AVP et Trend Micro/VirusWall
`sympa_antivirus_args`	:heavy_multiplication_x:	Argument de commande pour le plugin antivirus
`sympa_antispam_tag_header_name`	`X-Spam-Status`	Si un filtre anti-spam (comme spamassassin ou j-chkmail) ajoute des en-têtes smtp pour marquer les spams, nom de cet en-tête (exemple X-Spam-Status)
`sympa_antispam_tag_header_spam_regexp`	:heavy_multiplication_x:	Regexp appliqué sur cet en-tête pour vérifier si le message est un spam (exemple Oui)
`sympa_antispam_tag_header_ham_regexp`	:heavy_multiplication_x:	Regexp appliqué sur cet en-tête pour vérifier si le message n'est PAS un spam (exemple Non)
`sympa_spam_status`	:heavy_multiplication_x:	Les messages sont supposés être filtrés par un antispam qui ajoute encore des en-têtes aux messages. Ce paramètre est utilisé pour sélectionner un scénario spécial afin de décider le statut de spam du message : ham, spam ou incertain. Ce paramètre remplace les antispam_tag_header_name, antispam_tag_header_spam_regexp et antispam_tag_header_ham_regexp.
`sympa_arc_path`	`/var/lib/sympa/arc`	Répertoire pour stocker les archives HTML
`sympa_default_index`	`thrd`	Ordre d'index par défaut lors de l'entrée dans l'archive web : soit en mode filé ou en mode chronologique
`sympa_cookie_expire`	`0`	Durée de vie des cookies HTTP
`sympa_cookie_domain`	`localhost`	Domaine de validité des cookies HTTP
`sympa_cookie_refresh`	`60`	Intervalle moyen pour rafraîchir l'ID de session HTTP.
`sympa_custom_archiver`	:heavy_multiplication_x:	Active un archiviste personnalisé à utiliser à la place de MHonArc. La valeur de ce paramètre est le chemin absolu sur le système de fichiers vers le script de l'archiviste personnalisé.
`sympa_default_home`	`home`	Type de page web principale (listes, accueil)
`sympa_edit_list`	`owner`
`sympa_ldap_force_canonical_email`	`1`	Lors de l'utilisation de l'authentification LDAP, si l'identifiant fourni par l'utilisateur était une adresse e-mail valide, si ce paramètre est défini sur false, l'adresse e-mail fournie sera utilisée pour authentifier l'utilisateur. Sinon, l'utilisation de la première adresse e-mail retournée par le serveur LDAP sera privilégiée.
`sympa_review_page_size`	`25`	Nombre par défaut de lignes du tableau affichant les utilisateurs sur la page de révision
`sympa_web_page_title`	`Service de listes de diffusion`	Titre de la page web principale
`sympa_show_default_templates`	`false`	Afficher ou cacher les modèles de liste par défaut
`sympa_template_lists`	`[]`	Liste des modèles à définir.
`sympa_data_sources`	`false`	Liste des sources de données à définir.
`sympa_alias_manager`	``	Chemin vers l'exécutable du gestionnaire d'alias.
`sympa_ldap_alias_entry`	``	Chaîne multiligne, écrite dans `/etc/sympa/ldap_alias_entry.tt2`.
`sympa_ldap_alias_manager_conf`	``	Dictionnaire contenant les attributs de configuration du gestionnaire d'alias.
`sympa_auth`	`[{ name: "user:table", options: {regexp: ".*"}}]`	Liste des méthodes d'authentification utilisées dans l'ordre.

Variables de robots Sympa

sympa_robots est une liste de définitions de robots Sympa, vide par défaut. Chaque entrée contient :

Nom	Requis/Par défaut	Description
`domain`	:heavy_check_mark:	Domaine de messagerie et web du robot
`server_admin`	:heavy_check_mark:	Admin du VHost du serveur web
`listmaster`	:heavy_check_mark:	Liste des entrées de mail de listmaster
`listmaster`	:heavy_check_mark:
`create_list`