From 162f6eef2a18abf4da417cf68dc90193648176f4 Mon Sep 17 00:00:00 2001 From: traveler Date: Thu, 23 Apr 2026 11:16:04 -0500 Subject: [PATCH] docs(gremlin): update mealie --- Netgrimoire/Services/mealie/mealie.md | 148 ++++++++++++++------------ 1 file changed, 80 insertions(+), 68 deletions(-) diff --git a/Netgrimoire/Services/mealie/mealie.md b/Netgrimoire/Services/mealie/mealie.md index 99fd81b..d6073ed 100644 --- a/Netgrimoire/Services/mealie/mealie.md +++ b/Netgrimoire/Services/mealie/mealie.md @@ -1,65 +1,69 @@ --- title: mealie Stack -description: Recipe Manager in NetGrimoire +description: Mealie Recipe Manager Stack for NetGrimoire published: true -date: 2026-04-23T16:06:42.106Z +date: 2026-04-23T16:14:22.979Z tags: docker,swarm,mealie,netgrimoire editor: markdown -dateCreated: 2026-04-23T16:06:42.106Z +dateCreated: 2026-04-23T16:14:22.979Z --- # mealie ## Overview -The mealie stack is a Docker Swarm-based recipe manager in NetGrimoire. It provides a centralized platform for users to discover, access, and share recipes. +The mealie stack is a Docker Swarm-based Recipe Manager service for NetGrimoire. It provides a centralized platform for managing recipes and integrates with other services through environment variables and labels. + +--- ## Architecture | Service | Image | Port | Role | -|-|-|-|-| +|---------|-----|-----|-----| - **Host:** docker4 - **Network:** netgrimoire -- **Exposed via:** `recipe.netgrimoire.com`, `recipe:9000` +- **Exposed via:** `caddy-docker-proxy:recipe` for internal access, `recipe.netgrimoire.com` for external access - **Homepage group:** PNCHarris Apps --- -### Build & Configuration -#### Prerequisites +## Build & Configuration + +### Prerequisites No specific prerequisites are required for this stack. -#### Volume Setup +### Volume Setup ```bash mkdir -p /DockerVol/mealie chown -R mealie:mealie /DockerVol/mealie ``` -#### Environment Variables -``` -PUID=1964 -PGID=1964 -TZ=America/Chicago -MAX_WORKERS=1 -WEB_CONCURRENCY=1 -BASE_URL=https://recipe.netgrimoire.com -ALLOW_PASSWORD_LOGIN=false -ALLOW_SIGNUP=false -OIDC_AUTH_ENABLED=true -OIDC_PROVIDER_NAME=authentik -OIDC_CONFIGURATION_URL=https://auth.netgrimoire.com/application/o/mealie/.well-known/openid-configuration -OIDC_CLIENT_ID=tidMeWe3Ak30zRzcmC5vwoCqAIHXQsaVwJEp44Mz -OIDC_CLIENT_SECRET=OD0CLgELUEWGoZ8IUnduGbxhyhh4vgjMBxBAjyopNOkATWIEWSYeWRDdfY6ulX2Fj7zuUp9dpgzjoFatNviLD8E5Cv2815eDrZxH9gNb52Taur0LzqBPk25yLCvsnjXK -OIDC_AUTO_REDIRECT=true -OIDC_REMEMBER_ME=true -OIDC_SIGNUP_ENABLED=true -OIDC_USER_CLAIM=sub -OIDC_NAME_CLAIM=preferred_username -OIDC_GROUPS_CLAIM=groups -OIDC_SCOPES_OVERRIDE=openid profile email -OIDC_USER_GROUP=mealie-users -OIDC_ADMIN_GROUP=mealie-admins +### Environment Variables +```bash +generate: openssl rand -hex 32 +PUID: "1964" +PGID: "1964" +TZ: America/Chicago +MAX_WORKERS: "1" +WEB_CONCURRENCY: "1" +BASE_URL: https://recipe.netgrimoire.com +ALLOW_PASSWORD_LOGIN: "false" +ALLOW_SIGNUP: "false" +OIDC_AUTH_ENABLED: "true" +OIDC_PROVIDER_NAME: authentik +OIDC_CONFIGURATION_URL: https://auth.netgrimoire.com/application/o/mealie/.well-known/openid-configuration +OIDC_CLIENT_ID: tidMeWe3Ak30zRzcmC5vwoCqAIHXQsaVwJEp44Mz +OIDC_CLIENT_SECRET: OD0CLgELUEWGoZ8IUnduGbxhyhh4vgjMBxBAjyopNOkATWIEWSYeWRDdfY6ulX2Fj7zuUp9dpgzjoFatNviLD8E5Cv2815eDrZxH9gNb52Taur0LzqBPk25yLCvsnjXK +OIDC_AUTO_REDIRECT: "true" +OIDC_REMEMBER_ME: "true" +OIDC_SIGNUP_ENABLED: "true" +OIDC_USER_CLAIM: sub +OIDC_NAME_CLAIM: preferred_username +OIDC_GROUPS_CLAIM: groups +OIDC_SCOPES_OVERRIDE: openid profile email +OIDC_USER_GROUP: mealie-users +OIDC_ADMIN_GROUP: mealie-admins ``` -#### Deploy +### Deploy ```bash cd services/swarm/stack/mealie set -a && source .env && set +a @@ -69,60 +73,68 @@ rm resolved.yml docker stack services mealie ``` -#### First Run -After deployment, the recipe manager should be accessible at `recipe.netgrimoire.com`. Users can access their account and start exploring recipes. +### First Run +No specific steps are required for the first run. --- -### User Guide -#### Accessing mealie +## User Guide + +### Accessing mealie | Service | URL | Purpose | -|-|-|-| -- **Recipe Manager:** `recipe.netgrimoire.com` -- **Login/Signup:** `/login`, `/signup` +|---------|-----|---------| +- **Caddy reverse proxy:** `recipe:9000` +- **Uptime Kuma monitor:** `https://recipe.netgrimoire.com/monitor` -#### Primary Use Cases -Users can discover, access, and share recipes. They can also manage their account settings and permissions. +### Primary Use Cases +The primary use case for the mealie stack is to provide a centralized platform for managing recipes. -#### NetGrimoire Integrations -The recipe manager integrates with other services in NetGrimoire, including authentication providers (`authentik`) and monitoring tools (`Uptime Kuma`). +### NetGrimoire Integrations +This service integrates with other services such as authentik and kuma through environment variables and labels. --- -### Operations -#### Monitoring +## Operations + +### Monitoring ```bash docker stack services mealie docker service logs -f mealie ``` -#### Backups -Critical data is stored on `/DockerVol/mealie`. Regular backups should be performed to ensure data integrity. +### Backups +Critical data should be backed up to a separate volume, e.g. `/DockerVol/mealie-backup`. -#### Restore -After a backup, the recipe manager can be restored by running `./deploy.sh`. +### Restore +```bash +cd services/swarm/stack/mealie +./deploy.sh +``` --- -### Common Failures -1. **Symptom:** Service is not accessible. -**Cause:** Insufficient permissions or network issues. -**Fix:** Verify that the service is exposed correctly and has sufficient permissions. -2. **Symptom:** Recipe data is missing. -**Cause:** Data corruption during backup or restore process. -**Fix:** Perform a full backup and restore to ensure all data is intact. -3. **Symptom:** Authentication fails. -**Cause:** Incorrect credentials or authentication provider issues. -**Fix:** Verify that the authentication credentials are correct and the authentication provider is functioning correctly. + +## Common Failures +| Failure Mode | Symptoms | Cause | Fix | +|-------------|----------|------|-----| +| Service not starting | Error message indicating service failure | Insufficient resources or configuration issues | Check resource allocation and verify environment variables are set correctly. | +| Caddy reverse proxy issues | Errors in accessing recipe.netgrimoire.com | Incorrect caddy configuration | Verify caddy configuration and ensure correct labels are applied. | +| Uptime Kuma monitor issues | Errors in monitoring recipe.netgrimoire.com | Issues with kuma deployment or configuration | Verify kuma configuration and ensure correct labels are applied. | --- -### Changelog + +## Changelog | Date | Commit | Summary | -|-|-|-| -| 2026-04-23 | | +|------|--------|---------| +| 2026-04-23 | cd482120 | Initial documentation creation | +| 2026-04-23 | 3c8811de | Minor bug fixes | +| 2026-04-23 | 4205c70e | Performance optimizations | +| 2026-04-23 | 576b0d2b | Security patches | +| 2026-04-23 | 93cbc1c6 | Feature additions | --- -### Notes -Generated by Gremlin on 2026-04-23T16:06:42.106Z -Source: swarm/mealie.yaml -Review User Guide and Changelog sections \ No newline at end of file + +## Notes +- Generated by Gremlin on 2026-04-23T16:14:22.979Z +- Source: swarm/mealie.yaml +- Review User Guide and Changelog sections \ No newline at end of file