diff --git a/Taskfile.yml b/Taskfile.yml index 22ce80da1..a9ca44ac0 100644 --- a/Taskfile.yml +++ b/Taskfile.yml @@ -5,6 +5,7 @@ vars: GREETING: Hello, World! env: DEFAULT_GROUP: Home + DEFAULT_HOUSEHOLD: Family PRODUCTION: false API_PORT: 9000 API_DOCS: True diff --git a/docs/docs/documentation/getting-started/installation/backend-config.md b/docs/docs/documentation/getting-started/installation/backend-config.md index 844b2649c..fdad87700 100644 --- a/docs/docs/documentation/getting-started/installation/backend-config.md +++ b/docs/docs/documentation/getting-started/installation/backend-config.md @@ -9,6 +9,7 @@ | 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_HOUSEHOLD | Family | The default household for users in each group | | BASE_URL | http://localhost:8080 | Used for Notifications | | TOKEN_TIME | 48 | 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** | diff --git a/docs/docs/documentation/getting-started/installation/installation-checklist.md b/docs/docs/documentation/getting-started/installation/installation-checklist.md index b653c9b24..da2e7ffde 100644 --- a/docs/docs/documentation/getting-started/installation/installation-checklist.md +++ b/docs/docs/documentation/getting-started/installation/installation-checklist.md @@ -65,7 +65,7 @@ After you've decided setup the files it's important to set a few ENV variables t - [x] You've configured the relevant ENV variables for your database selection in the `docker-compose.yaml` files. - [x] You've configured the [SMTP server settings](./backend-config.md#email) (used for invitations, password resets, etc). You can setup a [google app password](https://support.google.com/accounts/answer/185833?hl=en) if you want to send email via gmail. - [x] You've set the [`BASE_URL`](./backend-config.md#general) variable. -- [x] You've set the `DEFAULT_EMAIL` and `DEFAULT_GROUP` variable. +- [x] You've set the `DEFAULT_EMAIL`, `DEFAULT_GROUP`, and `DEFAULT_HOUSEHOLD` variables. ## Step 4: Startup diff --git a/tests/unit_tests/test_config.py b/tests/unit_tests/test_config.py index 85bbe1021..cede06335 100644 --- a/tests/unit_tests/test_config.py +++ b/tests/unit_tests/test_config.py @@ -9,6 +9,7 @@ from mealie.core.settings.settings import AppSettings def test_non_default_settings(monkeypatch): monkeypatch.setenv("DEFAULT_GROUP", "Test Group") + monkeypatch.setenv("DEFAULT_HOUSEHOLD", "Test Household") monkeypatch.setenv("API_PORT", "8000") monkeypatch.setenv("API_DOCS", "False") @@ -16,6 +17,7 @@ def test_non_default_settings(monkeypatch): app_settings = get_app_settings() assert app_settings.DEFAULT_GROUP == "Test Group" + assert app_settings.DEFAULT_HOUSEHOLD == "Test Household" assert app_settings.API_PORT == 8000 assert app_settings.API_DOCS is False