Configuring SMTP Email

Overleaf only supports SMTP and AWS SES. If an e-mail server is enabled on your localhost, and it's listening to local connections, using SMTP will also work.

IMPORTANT: starting with Overleaf CE/Server Pro 5.0.1 environment variables have been rebranded from SHARELATEX_* to OVERLEAF_*.

If you're using a 4.x version (or earlier) please make sure the variables are prefix accordingly (e.g. SHARELATEX_EMAIL_FROM_ADDRESS instead of OVERLEAF_EMAIL_FROM_ADDRESS)

Configure

Email can be configured via environmental variables passed to the docker container.

Sender Configuration

• OVERLEAF_EMAIL_FROM_ADDRESS: REQUIRED - The from address e.g. 'support@mycompany.com'
• OVERLEAF_EMAIL_REPLY_TO: The reply to address e.g. 'noreply@mycompany.com'

AWS SES

• OVERLEAF_EMAIL_AWS_SES_ACCESS_KEY_ID: If using AWS SES the access key
• OVERLEAF_EMAIL_AWS_SES_SECRET_KEY: If using AWS SES the secret key
• OVERLEAF_EMAIL_AWS_SES_REGION: If not set, the default region is US-EAST-1

AWS SES with Instance Roles

• OVERLEAF_EMAIL_DRIVER: When this is set to ses, the email system will rely on the configured instance roles to send email.

SMTP

• OVERLEAF_EMAIL_SMTP_HOST: SMTP Host, needs to be accessible from the docker container
• OVERLEAF_EMAIL_SMTP_PORT: SMTP port to use
• OVERLEAF_EMAIL_SMTP_SECURE: Boolean if SMTP secure should be used
• OVERLEAF_EMAIL_SMTP_USER: User to authenticate against the STMP server with
• OVERLEAF_EMAIL_SMTP_PASS: Password for SMTP User
• OVERLEAF_EMAIL_SMTP_TLS_REJECT_UNAUTH: Rejected unauthorized tls connections
• OVERLEAF_EMAIL_SMTP_IGNORE_TLS: turns off STARTTLS support if true
• OVERLEAF_EMAIL_SMTP_NAME: optional hostname of the client, used for identifying to the server, defaults to hostname of the machine.
• OVERLEAF_EMAIL_SMTP_LOGGER: when set to true prints logging messages to web.log.

Customisation

• OVERLEAF_CUSTOM_EMAIL_FOOTER Custom HTML which is appended to all emails. e.g. --env OVERLEAF_CUSTOM_EMAIL_FOOTER="<div>This system is run by department x </div> <div> If you have any questions please look at our faq <a href='https://somwhere.com'>here</a></div>"