Envio de e-mails

Envie e-mails de ativação, convite e redefinição de senha a partir de uma implantação Kubernetes.

O serviço web envia todos os e-mails (ativação, convites para projetos, redefinição de senha) a partir de cada pod do Ayakaleaf Pro. As configurações são as mesmas do Toolkit; consulte Envio de e-mails.

Serviço	web, em cada pod do Ayakaleaf Pro; lido quando o web inicia
Pod → exterior	seu servidor SMTP (OVERLEAF_EMAIL_SMTP_HOST) ou a API do Amazon SES de OVERLEAF_EMAIL_AWS_SES_REGION
Estado	o limite de taxa de envio no Redis
Tarefas periódicas	nenhuma

​

Configuração

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 ativa o envio. Defina-a somente junto com o servidor SMTP (ou o SES): apenas com o remetente, o Ayakaleaf Pro tenta usar um servidor SMTP dentro do pod, e todos os e-mails falham. Sem ela, os e-mails não são enviados, apenas gravados no web.log.

   OVERLEAF_EMAIL_SMTP_SECURE, OVERLEAF_EMAIL_SMTP_IGNORE_TLS e OVERLEAF_EMAIL_SMTP_TLS_REJECT_UNAUTH são lidas como JSON, então use "true" ou "false": um valor como yes interrompe todos os serviços do pod na inicialização.

2. Secret

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

   Para a API do Amazon SES, coloque aqui OVERLEAF_EMAIL_AWS_SES_ACCESS_KEY_ID e OVERLEAF_EMAIL_AWS_SES_SECRET_KEY, e coloque OVERLEAF_EMAIL_DRIVER: ses e OVERLEAF_EMAIL_AWS_SES_REGION no ConfigMap.

3. Aplique, reinicie e teste

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

   Envie a si mesmo um e-mail de redefinição de senha a partir da página de login. Se ele não chegar, verifique se o servidor SMTP está acessível a partir dos pods e consulte o log do 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
   

​

Várias réplicas

Nada extra. Todas as réplicas enviam com as mesmas configurações, e o limite de taxa de envio é contado no Redis entre todas as réplicas. Se o seu servidor SMTP aceita apenas remetentes conhecidos, permita os endereços com os quais os pods saem do cluster (geralmente os dos nós).

​

Testado no Kubernetes

Com o Mailpit como servidor SMTP, no Kubernetes 1.37 com uma réplica, nossos testes de ponta a ponta que enviam e-mails passam: o e-mail de ativação de uma conta criada por um administrador, o e-mail de ativação de um autorregistro limitado a domínios, o e-mail de redefinição de senha, o e-mail informando a um usuário que sua conta foi excluída e o que acontece quando o servidor SMTP recusa um e-mail de ativação ou de exclusão: a conta ainda é criada ou excluída, e o e-mail de ativação pode ser reenviado mais tarde. Com OVERLEAF_EMAIL_FROM_ADDRESS e sem host SMTP, uma solicitação de redefinição de senha falhou com um erro, e o web.log mostrou “error sending message”, conforme descrito acima.