Envoi des e-mails

Envoyer les e-mails d’activation, d’invitation et de réinitialisation du mot de passe depuis un déploiement Kubernetes.

Le service web envoie tous les e-mails (activation, invitations à des projets, réinitialisation du mot de passe) depuis chaque pod Ayakaleaf Pro. Les paramètres sont les mêmes que sur le Toolkit, voir Envoi des e-mails.

Service	web, dans chaque pod Ayakaleaf Pro ; lu au démarrage de web
Pod → extérieur	votre serveur SMTP (OVERLEAF_EMAIL_SMTP_HOST), ou l’API Amazon SES de OVERLEAF_EMAIL_AWS_SES_REGION
État	la limite de débit d’envoi dans Redis
Tâches périodiques	aucune

​

Configuration

1. ConfigMap

   30-config.yaml (additions)

     OVERLEAF_EMAIL_FROM_ADDRESS: [e-mail]
     OVERLEAF_EMAIL_SMTP_HOST: smtp.example.com
     OVERLEAF_EMAIL_SMTP_PORT: "587"
     OVERLEAF_EMAIL_SMTP_SECURE: "false"
     OVERLEAF_EMAIL_SMTP_USER: [e-mail]
     # optional
     # OVERLEAF_EMAIL_REPLY_TO: [e-mail]
     # OVERLEAF_EMAIL_SMTP_IGNORE_TLS: "false"
     # OVERLEAF_EMAIL_SMTP_TLS_REJECT_UNAUTH: "true"
   

   OVERLEAF_EMAIL_FROM_ADDRESS active l’envoi. Ne le définissez qu’avec le serveur SMTP (ou SES) : avec l’expéditeur seul, Ayakaleaf Pro tente d’utiliser un serveur SMTP à l’intérieur du pod, et tous les e-mails échouent. Sans lui, les e-mails ne sont pas envoyés, mais seulement écrits dans web.log.

   OVERLEAF_EMAIL_SMTP_SECURE, OVERLEAF_EMAIL_SMTP_IGNORE_TLS et OVERLEAF_EMAIL_SMTP_TLS_REJECT_UNAUTH sont lus comme du JSON ; utilisez donc "true" ou "false" : une valeur telle que yes arrête tous les services du pod au démarrage.

2. Secret

   kubectl -n overleaf patch secret overleaf-secrets --type merge \
     -p '{"stringData":{"OVERLEAF_EMAIL_SMTP_PASS":"<SMTP password>"}}'
   

   Pour l’API Amazon SES, placez plutôt ici OVERLEAF_EMAIL_AWS_SES_ACCESS_KEY_ID et OVERLEAF_EMAIL_AWS_SES_SECRET_KEY, et OVERLEAF_EMAIL_DRIVER: ses ainsi que OVERLEAF_EMAIL_AWS_SES_REGION dans la ConfigMap.

3. Appliquer, redémarrer et tester

   kubectl apply -f 30-config.yaml
   kubectl -n overleaf rollout restart deployment/overleaf     # or statefulset/overleaf
   

   Envoyez-vous un e-mail de réinitialisation du mot de passe depuis la page de connexion. S’il n’arrive pas, vérifiez que le serveur SMTP est joignable depuis les pods et consultez le journal web :

   kubectl -n overleaf exec deploy/overleaf -- bash -c 'echo > /dev/tcp/smtp.example.com/587 && echo reachable'
   kubectl -n overleaf exec deploy/overleaf -- grep -iE "email|smtp" /var/log/overleaf/web.log | tail
   

​

Plusieurs réplicas

Rien de plus. Chaque réplica envoie avec les mêmes paramètres, et la limite de débit d’envoi est comptabilisée dans Redis pour l’ensemble des réplicas. Si votre serveur SMTP n’accepte que des expéditeurs connus, autorisez les adresses avec lesquelles les pods sortent du cluster (généralement celles des nœuds).

​

Testé sur Kubernetes

Avec Mailpit comme serveur SMTP, sur Kubernetes 1.37 avec un réplica, nos tests de bout en bout qui envoient des e-mails réussissent : l’e-mail d’activation d’un compte créé par un administrateur, l’e-mail d’activation d’une inscription libre limitée à certains domaines, l’e-mail de réinitialisation du mot de passe, l’e-mail informant un utilisateur de la suppression de son compte, et le comportement lorsque le serveur SMTP refuse un e-mail d’activation ou de suppression : le compte est tout de même créé ou supprimé, et l’e-mail d’activation peut être renvoyé plus tard. Avec OVERLEAF_EMAIL_FROM_ADDRESS et sans hôte SMTP, une demande de réinitialisation du mot de passe a échoué avec une erreur et web.log a affiché « error sending message », comme décrit ci-dessus.