Mirrors/mealie
1
0
Fork 0
mirror of https://github.com/mealie-recipes/mealie.git synced 2025-10-31 02:03:35 -04:00
Code Issues Packages Projects Releases Wiki Activity

Feature/email support (#720)

Browse Source 
* feat(frontend): ✨ add UI for testing email configuration

* feat(backend): ✨ add email service with common templates (WIP)

* test(backend): ✅ add basic tests for email configuration

* set defaults

* add email variables

Co-authored-by: Hayden <hay-kot@pm.me>
This commit is contained in:
Hayden
2021-10-03 18:38:45 -08:00
committed by GitHub
parent c0dd07f9e7
commit b7b8aa9a08
20 changed files with 1168 additions and 61 deletions
Download Patch File Download Diff File Expand all files Collapse all files

109
docs/docs/documentation/getting-started/install.md
View File

@@ -112,48 +112,79 @@ services:
POSTGRES_USER: mealie
```
## mealie-api Env Variables
## API Environment Variables
| Variables | Default | Description |
| ----------------- | :-------------------: | --------------------------------------------------------------------------------------------------------------------------------- |
| PUID | 911 | UserID permissions between host OS and container |
| PGID | 911 | GroupID permissions between host OS and container |
| DEFAULT_GROUP | Home | The default group for users |
| DEFAULT_EMAIL | changeme@email.com | The default username for the superuser |
| BASE_URL | http://localhost:8080 | Used for Notifications |
| DB_ENGINE | sqlite | Optional: 'sqlite', 'postgres' |
| POSTGRES_USER | mealie | Postgres database user |
| POSTGRES_PASSWORD | mealie | Postgres database password |
| POSTGRES_SERVER | postgres | Postgres database server address |
| POSTGRES_PORT | 5432 | Postgres database port |
| POSTGRES_DB | mealie | Postgres database name |
| TOKEN_TIME | 2 | The time in hours that a login/auth token is valid |
| API_PORT | 9000 | The port exposed by backend API. **Do not change this if you're running in Docker** |
| API_DOCS | True | Turns on/off access to the API documentation locally. |
| TZ | UTC | Must be set to get correct date/time on the server |
| WORKERS_PER_CORE | 1 | Set the number of workers to the number of CPU cores multiplied by this value (Value \* CPUs). More info [here][workers_per_core] |
| MAX_WORKERS | | Set the maximum number of workers to use. Default is not set meaning unlimited. More info [here][max_workers] |
| WEB_CONCURRENCY | 2 | Override the automatic definition of number of workers. More info [here][web_concurrency] |
### General
## mealie-frontend Env Variables
| Variables | Default | Description |
| ------------- | :-------------------: | ----------------------------------------------------------------------------------- |
| PUID | 911 | UserID permissions between host OS and container |
| PGID | 911 | GroupID permissions between host OS and container |
| DEFAULT_GROUP | Home | The default group for users |
| DEFAULT_EMAIL | changeme@email.com | The default username for the superuser |
| BASE_URL | http://localhost:8080 | Used for Notifications |
| TOKEN_TIME | 2 | The time in hours that a login/auth token is valid |
| API_PORT | 9000 | The port exposed by backend API. **Do not change this if you're running in Docker** |
| API_DOCS | True | Turns on/off access to the API documentation locally. |
| TZ | UTC | Must be set to get correct date/time on the server |
| Variables | Default | Description |
| --------------------- | :-----: | ---------------------------------- |
| ALLOW_SIGNUP | true | Allows anyone to signup for Mealie |
| THEME_LIGHT_PRIMARY | #E58325 | Light Theme Config Variable |
| THEME_LIGHT_ACCENT | #007A99 | Light Theme Config Variable |
| THEME_LIGHT_SECONDARY | #973542 | Light Theme Config Variable |
| THEME_LIGHT_SUCCESS | #43A047 | Light Theme Config Variable |
| THEME_LIGHT_INFO | #1976D2 | Light Theme Config Variable |
| THEME_LIGHT_WARNING | #FF6D00 | Light Theme Config Variable |
| THEME_LIGHT_ERROR | #EF5350 | Light Theme Config Variable |
| DARK_LIGHT_PRIMARY | #E58325 | Dark Theme Config Variable |
| DARK_LIGHT_ACCENT | #007A99 | Dark Theme Config Variable |
| DARK_LIGHT_SECONDARY | #973542 | Dark Theme Config Variable |
| DARK_LIGHT_SUCCESS | #43A047 | Dark Theme Config Variable |
| DARK_LIGHT_INFO | #1976D2 | Dark Theme Config Variable |
| DARK_LIGHT_WARNING | #FF6D00 | Dark Theme Config Variable |
| DARK_LIGHT_ERROR | #EF5350 | Dark Theme Config Variable |
### Database
| Variables | Default | Description |
| ----------------- | :------: | -------------------------------- |
| DB_ENGINE | sqlite | Optional: 'sqlite', 'postgres' |
| POSTGRES_USER | mealie | Postgres database user |
| POSTGRES_PASSWORD | mealie | Postgres database password |
| POSTGRES_SERVER | postgres | Postgres database server address |
| POSTGRES_PORT | 5432 | Postgres database port |
| POSTGRES_DB | mealie | Postgres database name |
### Email
| Variables | Default | Description |
| --------------- | :-----: | ------------------ |
| SMTP_HOST | None | Required For email |
| SMTP_PORT | 587 | Required For email |
| SMTP_FROM_NAME | Mealie | Required For email |
| SMTP_TLS | true | Required For email |
| SMTP_FROM_EMAIL | None | Required For email |
| SMTP_USER | None | Required For email |
| SMTP_PASSWORD | None | Required For email |
### Webworkers
| Variables | Default | Description |
| ---------------- | :-----: | --------------------------------------------------------------------------------------------------------------------------------- |
| WORKERS_PER_CORE | 1 | Set the number of workers to the number of CPU cores multiplied by this value (Value \* CPUs). More info [here][workers_per_core] |
| MAX_WORKERS | | Set the maximum number of workers to use. Default is not set meaning unlimited. More info [here][max_workers] |
| WEB_CONCURRENCY | 2 | Override the automatic definition of number of workers. More info [here][web_concurrency] |
## Frontend Environment Variables
### General
| Variables | Default | Description |
| ------------ | :-----: | ---------------------------------- |
| ALLOW_SIGNUP | true | Allows anyone to signup for Mealie |
## Themeing
| Variables | Default | Description |
| --------------------- | :-----: | --------------------------- |
| THEME_LIGHT_PRIMARY | #E58325 | Light Theme Config Variable |
| THEME_LIGHT_ACCENT | #007A99 | Light Theme Config Variable |
| THEME_LIGHT_SECONDARY | #973542 | Light Theme Config Variable |
| THEME_LIGHT_SUCCESS | #43A047 | Light Theme Config Variable |
| THEME_LIGHT_INFO | #1976D2 | Light Theme Config Variable |
| THEME_LIGHT_WARNING | #FF6D00 | Light Theme Config Variable |
| THEME_LIGHT_ERROR | #EF5350 | Light Theme Config Variable |
| DARK_LIGHT_PRIMARY | #E58325 | Dark Theme Config Variable |
| DARK_LIGHT_ACCENT | #007A99 | Dark Theme Config Variable |
| DARK_LIGHT_SECONDARY | #973542 | Dark Theme Config Variable |
| DARK_LIGHT_SUCCESS | #43A047 | Dark Theme Config Variable |
| DARK_LIGHT_INFO | #1976D2 | Dark Theme Config Variable |
| DARK_LIGHT_WARNING | #FF6D00 | Dark Theme Config Variable |
| DARK_LIGHT_ERROR | #EF5350 | Dark Theme Config Variable |
## Raspberry Pi 4