UniqAI/hexabot
1
0
Fork 0
mirror of https://github.com/hexastack/hexabot synced 2025-01-22 18:45:57 +00:00
Code Issues Actions 13 Packages Projects Releases Wiki Activity

GITBOOK-129: Update SMTP Configuration

Browse Source
This commit is contained in:
Chedli Ben Yaghlane 2025-01-17 10:58:02 +00:00 committed by gitbook-bot
parent 4ea2aac3ec
commit 15bdd32595
No known key found for this signature in database
GPG Key ID: 07D2180C7B12D0FF
1 changed files with 3 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/developer-guide/smtp-configuration-and-emails.md
View File

@ -1,7 +1,7 @@
# SMTP Configuration and Emails
{% hint style="info" %}
Make sure you have a **.env** file created under the \`docker/\` folder. You can either copy .env.example or run \`make init\` to create that file. The **.env** file contains environment variables that we use for configuring the Hexabot instance.
Make sure you have a **.env** file created under the `docker/` folder. You can either copy .env.example or run `hexabot init` to create that file. The **.env** file contains environment variables that we use for configuring the Hexabot instance.
{% endhint %}
## **Development Environment**
@ -9,9 +9,9 @@ Make sure you have a **.env** file created under the \`docker/\` folder. You can
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.
You can run the app without using SMTP by setting the environment variable `EMAIL_SMTP_ENABLED=false`. Simply run `hexabot start` and invite a new 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.
We use `smtp4dev` for email testing in the development environment. To use this service, set the `EMAIL_SMTP_ENABLED` to `true` in the `.env` file and restart the app. Then, invite a new 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)**