mirrors/overleaf
1
0
Fork 0
mirror of https://github.com/overleaf/overleaf.git synced 2025-12-05 01:10:29 +00:00
Code Issues Packages Projects Releases Wiki Activity
Page: Configuring SMTP Email
Pages
Configuring Headers, Footers & Logo Configuring Overleaf Configuring SMTP Email Creating and managing users Data and Backups Database migrations Dependencies Doc version recovery Docker Compose Files Editor and Compile Process FAQ Fixing SyncTeX errors in Server Pro 2.0.0 and 2.0.1 Full Project History Migration Getting Server Pro Git Integration HTTPS reverse proxy using Nginx Hardware Requirements Home Horizontal Scaling Legacy user export script Log files Password restrictions Project check script Quick Start Guide Release Notes 0.1.2 Release Notes 0.1.3 and 0.1.4 Release Notes 0.2.0 Release Notes 0.3.0 Release Notes 0.4.0 Release Notes 0.5.0 Release Notes 0.6.0 Release Notes 1.0.0 Release Notes 4.x.x Release Notes 2.0 Release Notes 3.x.x Release Notes 5.x.x S3 Migration S3 Server Pro infrastructure Server Pro: Adding learn pages Server Pro: LDAP Config (legacy) Server Pro: LDAP Config Server Pro: Migrating to LDAP or SAML Server Pro: SAML Config Server Pro: Sandboxed Compiles Server Pro: Setting up templates Server Pro: Setup Troubleshooting Updating Mongo version Upgrading Containers i18n Languages
Clone
20
Configuring SMTP Email
Mathew Evans edited this page 2025-08-22 16:31:57 +01:00
Table of Contents

Important

This page has been moved. Please update your bookmarks.

Click here to be redirected to our new on-premises documentation.

View outdated content

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>"

Setup & Managing Overleaf

Server Pro

Legacy