Raphaël Numbus
24 lines
1.7 KiB
Markdown
24 lines
1.7 KiB
Markdown
# Numbus Server documentation
|
|
|
|
## 📬 Configuring the mail settings
|
|
|
|
| Variable | Description | Values | Default |
|
|
| -------- | ----------- | ------ | --------- |
|
|
| SMTP_SERVER_USERNAME | The email address used to send automated emails (alerts, notifications). | "your-address@your-domain.com" | |
|
|
| SMTP_SERVER_PASSWORD | The password or app-specific password for the email account. | "your-secure-password" | |
|
|
| SMTP_SERVER_HOST | The address of the SMTP server. | "smtp.yourdomain.com" | "smtp.gmail.com" |
|
|
| SMTP_SERVER_PORT | The port number for the SMTP server. | "587" or "465" | "587" |
|
|
|
|
## ❓ I don't already have an SMTP capable email
|
|
|
|
If your provider doesn't support **standard SMTP**, the easiest solution is to create a **free Gmail account** dedicated to your server.
|
|
|
|
Gmail allows you to generate an **App Password** which works perfectly for automated alerts.
|
|
|
|
1. Navigate to the [Google account creation page](https://accounts.google.com/signup). Follow the prompts to create your account. Feel free **not to provide** real information about yourself. Giving your phone number and home address is **not needed**.
|
|
|
|
2. Once your account is **created** navigate to the [Google account settings](https://myaccount.google.com).
|
|
|
|
3. In the security page, enable the **two factor authentication (2FA)**. The best way to enable 2FA without providing too much information is using **TOTP codes** (under Authenticator label). You can use the open-source [Ente Auth](https://ente.io/auth/) app to get your **TOTP codes**.
|
|
|
|
4. Finally, once **2FA** is enabled, you can generate an **app password**. Navigate to the [app passwords page](https://myaccount.google.com/apppasswords). Generate an app password and call it "numbus-server" to **remember** what it is used for. |