UniqAI/hexabot
1
0
Fork 0
mirror of https://github.com/hexastack/hexabot synced 2025-03-10 14:25:42 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

GITBOOK-56: No subject

Browse Source
This commit is contained in:
Mohamed Marrouchi 2024-09-18 16:49:39 +00:00 committed by gitbook-bot
parent efeb651f8b
commit 162a2d830c
No known key found for this signature in database
GPG Key ID: 07D2180C7B12D0FF
2 changed files with 48 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
docs/SUMMARY.md
View File

@ -54,6 +54,7 @@
* [Plugins](developer-guide/integrations/README.md) * [Plugins](developer-guide/integrations/README.md)
* [Build Your First plugin](developer-guide/integrations/build-your-first-plugin.md) * [Build Your First plugin](developer-guide/integrations/build-your-first-plugin.md)
* [RAG Plugin](developer-guide/integrations/openapi.md) * [RAG Plugin](developer-guide/integrations/openapi.md)
* [SMTP Configuration and Emails](developer-guide/smtp-configuration-and-emails.md)
## Key Concepts ## Key Concepts

47
docs/developer-guide/smtp-configuration-and-emails.md Normal file
View File

@ -0,0 +1,47 @@
# SMTP Configuration and Emails
## **Development Environment**
You have two options for handling email functionality during development:
1. **Without SMTP**:\
You can run the app without using SMTP by setting the environment variable `EMAIL_SMTP_ENABLED=false`. Simply run `make start` and invite a user. The app will behave as though it is sending emails, but nothing will happen in the background.
2. **Using smtp4dev for Testing**:\
We use `smtp4dev` for email testing in the development environment. To use this service, run the app with `make start SMTP4DEV=1`. Then, invite a user or reset a password and check whether emails are received in the smtp4dev UI interface at [http://localhost:9002/](http://localhost:9002/). This also applies to other scenarios like the confirmation email after signup and the password reset email.
**SMTP Config (Local Dev)**
For local development with `smtp4dev`, configure the following environment variables:
```makefile
APP_SMTP_4_DEV_PORT=9002
EMAIL_SMTP_ENABLED=false
EMAIL_SMTP_HOST=smtp4dev
EMAIL_SMTP_PORT=25
EMAIL_SMTP_SECURE=false
EMAIL_SMTP_USER=dev_only
EMAIL_SMTP_PASS=dev_only
EMAIL_SMTP_FROM=noreply@example.com
```
## **Production Environment**
In production, use a third-party SMTP service by configuring the environment variables before running `make start`:
```makefile
EMAIL_SMTP_ENABLED=true
EMAIL_SMTP_HOST=sandbox.smtp.mailtrap.io
EMAIL_SMTP_PORT=2525
EMAIL_SMTP_SECURE=false
EMAIL_SMTP_USER=***************
EMAIL_SMTP_PASS=***************
EMAIL_SMTP_FROM=from@example.com
```
## **Customizing Email Templates**
Email templates are located in the `api/src/templates` folder. These templates are written in **MJML syntax** (you can read more about [MJML here](https://mjml.io/)).
## **Translations**
Email strings are translated using the i18n system. You can find the translation files in the `api/src/config/i18n` folder.