github/endurain
1
1
Fork 0
mirror of https://github.com/joaovitoriasilva/endurain.git synced 2026-01-09 15:57:59 -05:00
Code Issues 45 Packages Projects Releases Wiki Activity

Update SMTP config and docs for email notifications

Browse Source 
Changed example SMTP settings in .env.example to use ProtonMail and generic email address. Added detailed SMTP environment variable documentation to advanced-started.md. Updated index.md to mention Apprise and password reset via email.
This commit is contained in:
João Vitória Silva
2025-09-04 12:28:30 +01:00
parent 6e80f74fe2
commit 97eb4bc829
3 changed files with 10 additions and 3 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
docs/getting-started/advanced-started.md
View File

@@ -44,6 +44,12 @@ Table below shows supported environment variables. Variables marked with optiona
| JAEGER_PORT | 4317 | Yes | N/A |
| BEHIND_PROXY | false | Yes | Change to true if behind reverse proxy |
| ENVIRONMENT | production | Yes | "production" and "development" allowed. "development" allows connections from localhost:8080 and localhost:5173 at the CORS level |
| SMTP_HOST | No default set | Yes | The SMTP host of your email provider. Example `smtp.protonmail.ch` |
| SMTP_PORT | 587 | Yes | The SMTP port of your email provider. Default is 587 |
| SMTP_USERNAME | No default set | Yes | The username of your SMTP email provider, probably your email address |
| SMTP_PASSWORD | No default set | Yes | The password of your SMTP email provider. Some providers allow the use of your account password, others require the creation of an app password. Please refer to your provider documentation |
| SMTP_SECURE | true | Yes | By default it uses secure communications. Accepted values are `true` and `false` |
| SMTP_SECURE_TYPE | starttls | Yes | If SMTP_SECURE is set you can set the communication type. Accepted values are `starttls` and `ssl` |
Table below shows the obligatory environment variables for mariadb container. You should set them based on what was also set for the Endurain container.