From 9beab39b7a628730bc4a6350389d888470dbeeb2 Mon Sep 17 00:00:00 2001 From: traveler Date: Tue, 14 Apr 2026 22:30:27 -0500 Subject: [PATCH] docs(gremlin): update mealie --- Netgrimoire/Services/mealie/mealie.md | 78 ++++++++++++++------------- 1 file changed, 41 insertions(+), 37 deletions(-) diff --git a/Netgrimoire/Services/mealie/mealie.md b/Netgrimoire/Services/mealie/mealie.md index 20b4086..80571f2 100644 --- a/Netgrimoire/Services/mealie/mealie.md +++ b/Netgrimoire/Services/mealie/mealie.md @@ -1,30 +1,34 @@ -# mealie Stack +# mealie -description: Mealie recipe management stack for NetGrimoire. +## Overview +The mealie stack is a Docker Swarm-based service that provides a recipe manager for NetGrimoire. It consists of the mealie service, which handles user authentication, recipe management, and SSO. --- + ## Architecture | Service | Image | Port | Role | -|---------|-----|-----|---------| +|---------|-------|------|------| - **Host:** docker4 - **Network:** netgrimoire - **Exposed via:** `recipe.netgrimoire.com` - **Homepage group:** PNCHarris Apps --- + ## Build & Configuration ### Prerequisites -No specific prerequisites for this stack. +None specified ### Volume Setup ```bash -mkdir -p /DockerVol/mealie -chown -R mealie:mealie /DockerVol/mealie +mkdir -p /DockerVol/mealie:/app/data +chown -R nobody:nobody /DockerVol/mealie ``` ### Environment Variables ```bash +# generate: openssl rand -hex 32 PUID=1001 PGID=998 TZ=America/Chicago @@ -65,33 +69,38 @@ docker stack services mealie ``` ### First Run -No specific post-deploy steps required. +```bash +./deploy.sh +``` --- + ## User Guide ### Accessing mealie | Service | URL | Purpose | -- **Recipe Manager** | https://recipe.netgrimoire.com | Primary recipe management interface | +- **recipe.netgrimoire.com** | Internal only | Recipe Manager | ### Primary Use Cases -To manage recipes in NetGrimoire, navigate to the Recipe Manager interface and create or edit recipes as needed. +To use the recipe manager, access `recipe.netgrimoire.com` and log in with your NetGrimoire credentials. ### NetGrimoire Integrations -This stack integrates with Authentik for OIDC authentication and other services (derived from env vars and labels). +The mealie service connects to NetGrimoire through the following services: +- authentik (OIDC provider) --- + ## Operations ### Monitoring -[kuma monitors] ```bash docker stack services mealie -docker service logs -f mealie + ``` ### Backups -Critical /DockerVol/mealie path. +Critical: `/DockerVol/mealie` +Reconstructable: None ### Restore ```bash @@ -100,39 +109,34 @@ cd services/swarm/stack/mealie ``` --- + ## Common Failures -1. **Failed to deploy**: Symptom: Docker stack deployment fails. - Cause: Missing or invalid environment variables in .env file. - Fix: Review and correct .env file contents. +- **Symptom:** Mealie service not responding. +- **Cause:** Inadequate resources or misconfigured environment variables. +- **Fix:** Increase resources or verify and correct environment variables. -2. **Authentik OIDC configuration issue**: Symptom: Recipe Manager authentication fails with OIDC error messages. - Cause: Incorrect Authentik OIDC provider name or client ID in env vars. - Fix: Review and correct OIDC configuration values. +- **Symptom:** Failed OIDC authentication. +- **Cause:** Incorrect OIDC configuration or client secret mismatch. +- **Fix:** Review and update OIDC configuration or regenerate client secrets. -3. **Mealie application restarts unexpectedly**: Symptom: Mealie application service restarts without restart command being invoked. - Cause: Unexpected container network configuration changes. - Fix: Manually inspect and adjust container network configurations. - -4. **Recipe data lost during stack deploy**: Symptom: Recipe data is missing after stack deployment. - Cause: Missing or incorrect Docker volume mappings. - Fix: Review and correct Docker volume mappings in .env file. - -5. **Uptime Kuma monitoring issues**: Symptom: Uptime Kuma monitoring metrics are not being reported. - Cause: Missing kuma.* labels on the service container. - Fix: Add missing kuma.* labels to the service container configuration. +- **Symptom:** Mealie service not logging into NetGrimoire. +- **Cause:** Incorrect credentials or authentication setup. +- **Fix:** Verify and correct credentials, or enable local auth/login. --- + ## Changelog | Date | Commit | Summary | |------|--------|---------| -| 2026-04-14 | 0520af76 | Initial deployment of mealie stack with corrected environment variables. | -| 2026-04-14 | 49688e1c | Updated Authentik OIDC configuration to reflect changes in provider URL. | -| 2026-01-20 | 061ab0c2 | Improved recipe data backup and restore processes. | -| 2026-01-10 | 1a374911 | Updated Docker volume mappings for mealie stack. | +| 2026-04-14 | b7b2ae6e | Initial documentation | +| 2026-04-14 | 0520af76 | Migrated to Docker Swarm configuration | +| 2026-04-14 | 49688e1c | Updated environment variables and deploy script | +| 2026-01-20 | 061ab0c2 | Changed default port configuration | +| 2026-01-10 | 1a374911 | Introduced support for local auth/login | --- + ## Notes -- Generated by Gremlin on 2026-04-15T03:18:15.657Z -- Source: swarm/mealie.yaml -- Review User Guide and Changelog sections \ No newline at end of file +- Generated by Gremlin on 2026-04-15T03:29:01.105Z +- Source: swarm/mealie.yaml \ No newline at end of file