Email verification and Password Reset
For a quick overview, refer to the user guide provided here: Password Reset
General setup
Basic Configuration
If you want to use one of the predefined services, configure only these variables: For more info about supported email services: https://community.nodemailer.com/2-0-0-beta/setup-smtp/well-known-services/
| Key | Type | Description | Example |
|---|---|---|---|
| EMAIL_SERVICE | string | Email service (e.g., Gmail, Outlook). | EMAIL_SERVICE= |
| EMAIL_USERNAME | string | Username for authentication. | EMAIL_USERNAME= |
| EMAIL_PASSWORD | string | Password for authentication. | EMAIL_PASSWORD= |
| EMAIL_FROM_NAME | string | From name. | EMAIL_FROM_NAME= |
| EMAIL_FROM | string | From email address. Required. | [email protected] |
Advanced Configuration
If you want to use a generic SMTP service or need advanced configuration for one of the predefined providers, configure these variables as well:
| Key | Type | Description | Example |
|---|---|---|---|
| EMAIL_HOST | string | Mail server host. | EMAIL_HOST= |
| EMAIL_PORT | number | Mail server port. | EMAIL_PORT=25 |
| EMAIL_ENCRYPTION | string | Encryption method (starttls, tls, etc.). | EMAIL_ENCRYPTION= |
| EMAIL_ENCRYPTION_HOSTNAME | string | Hostname for encryption. | EMAIL_ENCRYPTION_HOSTNAME= |
| EMAIL_ALLOW_SELFSIGNED | boolean | Allow self-signed certificates. | EMAIL_ALLOW_SELFSIGNED= |
⚠️
Warning
Setup with Gmail
To set up Gmail, follow these steps:
- Create a Google Account and enable 2-step verification.
- In the Google Account settings, click on the “Security” tab and open “2-step verification.”
- Scroll down and open “App passwords.” Choose “Mail” for the app and select “Other” for the device, then give it a random name.
- Click on “Generate” to create a password, and copy the generated password.
- In the
.envfile, modify the variables as follows:
| Key | Type | Description | Example |
|---|---|---|---|
| EMAIL_SERVICE | string | gmail | EMAIL_SERVICE=gmail |
| EMAIL_USERNAME | string | your-email | EMAIL_USERNAME=your-email |
| EMAIL_PASSWORD | string | your-email-password | EMAIL_PASSWORD=your-email-password |
| EMAIL_FROM | string | email address for the from field, e.g., [email protected] | [email protected] |
| EMAIL_FROM_NAME | string | My LibreChat Server | EMAIL_FROM_NAME=LibreChat |
Setup with custom mail server
To set up a custom mail server, follow these steps:
- Gather your SMTP login data from your provider. The steps are different for each, but they will usually list values for all variables.
- In the
.envfile, modify the variables as follows, assuming some sensible example values:
| Key | Type | Description | Example |
|---|---|---|---|
| EMAIL_HOST | string | Hostname to connect to | EMAIL_HOST=mail.example.com |
| EMAIL_PORT | integer | Port to connect to | EMAIL_PORT=25 |
| EMAIL_ENCRYPTION | string | Encryption type | EMAIL_ENCRYPTION=starttls |
| EMAIL_USERNAME | string | Your email username | [email protected] |
| EMAIL_PASSWORD | string | Your app password | EMAIL_PASSWORD=password |
| EMAIL_FROM | string | Email address for the from field | [email protected] |
| EMAIL_FROM_NAME | string | Name that will appear in the "from" field | EMAIL_FROM_NAME=LibreChat |