Doručování e-mailů

Odesílání aktivačních e-mailů, pozvánek a e-mailů pro obnovení hesla z nasazení na Kubernetes.

Služba web odesílá všechny e-maily (aktivace, pozvánky do projektů, obnovení hesla) z každého podu Ayakaleaf Pro. Nastavení jsou stejná jako v Toolkitu, viz Doručování e-mailů.

Služba	web, v každém podu Ayakaleaf Pro; načítá se při spuštění služby web
Pod → ven	váš server SMTP (OVERLEAF_EMAIL_SMTP_HOST), nebo Amazon SES API oblasti OVERLEAF_EMAIL_AWS_SES_REGION
Stav	limit rychlosti odesílání v Redisu
Periodické úlohy	žádné

​

Konfigurace

1. ConfigMapa

   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 zapíná odesílání. Nastavte ho pouze společně se serverem SMTP (nebo SES): se samotným odesílatelem zkouší Ayakaleaf Pro server SMTP uvnitř podu a každý e-mail selže. Bez něj se e-maily neodesílají, pouze se zapisují do web.log.

   OVERLEAF_EMAIL_SMTP_SECURE, OVERLEAF_EMAIL_SMTP_IGNORE_TLS a OVERLEAF_EMAIL_SMTP_TLS_REJECT_UNAUTH se čtou jako JSON, proto použijte "true" nebo "false": hodnota jako yes zastaví při spuštění všechny služby podu.

2. Secret

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

   Pro Amazon SES API sem místo toho vložte OVERLEAF_EMAIL_AWS_SES_ACCESS_KEY_ID a OVERLEAF_EMAIL_AWS_SES_SECRET_KEY a do ConfigMapy OVERLEAF_EMAIL_DRIVER: ses a OVERLEAF_EMAIL_AWS_SES_REGION.

3. Aplikujte, restartujte a otestujte

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

   Pošlete si z přihlašovací stránky e-mail pro obnovení hesla. Pokud nedorazí, ověřte, že je server SMTP z podů dostupný, a podívejte se do logu služby 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íce replik

Nic dalšího není potřeba. Každá replika odesílá se stejným nastavením a limit rychlosti odesílání se počítá v Redisu napříč všemi replikami. Pokud váš server SMTP přijímá pouze známé odesílatele, povolte adresy, se kterými pody opouštějí cluster (obvykle adresy uzlů).

​

Otestováno na Kubernetes

S Mailpitem jako serverem SMTP, na Kubernetes 1.37 s jednou replikou, procházejí naše end-to-end testy, které odesílají e-maily: aktivační e-mail účtu vytvořeného administrátorem, aktivační e-mail samoregistrace omezené na domény, e-mail pro obnovení hesla, e-mail informující uživatele o smazání jeho účtu a to, co se stane, když server SMTP aktivační nebo mazací e-mail odmítne: účet je přesto vytvořen nebo smazán a aktivační e-mail lze později odeslat znovu. S OVERLEAF_EMAIL_FROM_ADDRESS a bez hostitele SMTP selhal požadavek na obnovení hesla s chybou a web.log zobrazil „error sending message“, jak je popsáno výše.