Levering af e-mail

Send aktiverings-, invitations- og nulstillings-e-mails fra en Kubernetes-udrulning.

web-tjenesten sender alle e-mails (aktivering, projektinvitationer, nulstilling af adgangskode) fra hver Ayakaleaf Pro-pod. Indstillingerne er de samme som i Toolkit, se Levering af e-mail.

Tjeneste	web, i hver Ayakaleaf Pro-pod; læses, når web starter
Pod → omverdenen	din SMTP-server (OVERLEAF_EMAIL_SMTP_HOST) eller Amazon SES-API’et for OVERLEAF_EMAIL_AWS_SES_REGION
Tilstand	hastighedsbegrænsningen for afsendelse i Redis
Periodiske job	ingen

​

Konfiguration

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 slår afsendelse til. Angiv den kun sammen med SMTP-serveren (eller SES): med afsenderen alene forsøger Ayakaleaf Pro at bruge en SMTP-server inde i poden, og alle e-mails fejler. Uden den sendes e-mails ikke, men skrives kun til web.log.

   OVERLEAF_EMAIL_SMTP_SECURE, OVERLEAF_EMAIL_SMTP_IGNORE_TLS og OVERLEAF_EMAIL_SMTP_TLS_REJECT_UNAUTH læses som JSON, så brug "true" eller "false": en værdi som yes stopper alle podens tjenester ved opstart.

2. Secret

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

   For Amazon SES-API’et skal du i stedet lægge OVERLEAF_EMAIL_AWS_SES_ACCESS_KEY_ID og OVERLEAF_EMAIL_AWS_SES_SECRET_KEY her og OVERLEAF_EMAIL_DRIVER: ses og OVERLEAF_EMAIL_AWS_SES_REGION i ConfigMap’en.

3. Anvend, genstart og test

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

   Send dig selv en e-mail til nulstilling af adgangskode fra loginsiden. Hvis den ikke kommer frem, skal du kontrollere, at SMTP-serveren kan nås fra podsene, og kigge i web-loggen:

   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
   

​

Flere replikaer

Intet ekstra. Hver replika sender med de samme indstillinger, og hastighedsbegrænsningen for afsendelse tælles i Redis på tværs af alle replikaer. Hvis din SMTP-server kun accepterer kendte afsendere, skal du tillade de adresser, som podsene forlader clusteret med (normalt nodernes).

​

Testet på Kubernetes

Med Mailpit som SMTP-server, på Kubernetes 1.37 med én replika, består vores end-to-end-test, der sender e-mail: aktiverings-e-mailen for en konto, som en administrator opretter, aktiverings-e-mailen for en selvregistrering begrænset til domæner, e-mailen til nulstilling af adgangskode, e-mailen, der fortæller en bruger, at kontoen er slettet, og hvad der sker, når SMTP-serveren afviser en aktiverings- eller sletnings-e-mail: kontoen oprettes eller slettes stadig, og aktiverings-e-mailen kan sendes igen senere. Med OVERLEAF_EMAIL_FROM_ADDRESS og ingen SMTP-vært fejlede en anmodning om nulstilling af adgangskode med en fejl, og web.log viste „error sending message”, som beskrevet ovenfor.