docs(gremlin): update mealie
This commit is contained in:
parent
3a560ab7c9
commit
6c78e9b3aa
1 changed files with 46 additions and 39 deletions
|
|
@ -1,42 +1,46 @@
|
||||||
|
# mealie Stack
|
||||||
|
|
||||||
|
description: Mealie Recipe Manager
|
||||||
|
|
||||||
---
|
---
|
||||||
title: mealie Stack
|
title: mealie Stack
|
||||||
description: Recipe Manager for NetGrimoire
|
description: Mealie Recipe Manager
|
||||||
published: true
|
published: true
|
||||||
date: 2026-04-15T20:46:39.787Z
|
date: 2026-04-15T23:00:05.081Z
|
||||||
tags: docker,swarm,mealie,netgrimoire
|
tags: docker,swarm,mealie,netgrimoire
|
||||||
editor: markdown
|
editor: markdown
|
||||||
dateCreated: 2026-04-15T20:46:39.787Z
|
dateCreated: 2026-04-15T23:00:05.081Z
|
||||||
---
|
|
||||||
|
|
||||||
|
---
|
||||||
# mealie
|
# mealie
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
The mealie Stack is a Docker Swarm configuration for the Mealie recipe manager in NetGrimoire. It provides a centralized platform for managing recipes and cooking instructions. The stack consists of several services, including a Caddy reverse proxy, Kuma monitoring, and a homepage group.
|
The mealie stack is a Docker Swarm-based recipe manager that provides a centralized platform for managing recipes in NetGrimoire. It consists of several services, including the primary service and a reverse proxy.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Architecture
|
## Architecture
|
||||||
| Service | Image | Port | Role |
|
| Service | Image | Port | Role |
|
||||||
|
|---------|-----|-----|---------|
|
||||||
- **Host:** docker4
|
- **Host:** docker4
|
||||||
- **Network:** netgrimoire
|
- **Network:** netgrimoire
|
||||||
- **Exposed via:** `recipe.netgrimoire.com`, `recipe:9000`
|
- **Exposed via:** recipe.netgrimoire.com
|
||||||
- **Homepage group:** PNCHarris Apps
|
- **Homepage group:** PNCHarris Apps
|
||||||
|
|
||||||
---
|
---
|
||||||
|
# mealie
|
||||||
|
|
||||||
## Build & Configuration
|
## Build & Configuration
|
||||||
|
|
||||||
### Prerequisites
|
### Prerequisites
|
||||||
No specific prerequisites are required for this stack.
|
None
|
||||||
|
|
||||||
### Volume Setup
|
### Volume Setup
|
||||||
```bash
|
```bash
|
||||||
mkdir -p /DockerVol/mealie
|
mkdir -p /DockerVol/mealie:/app/data
|
||||||
chown -R 1001:1001 /DockerVol/mealie
|
chown -R 1001:1001 /DockerVol/mealie
|
||||||
```
|
```
|
||||||
|
|
||||||
### Environment Variables
|
### Environment Variables
|
||||||
```
|
```bash
|
||||||
PUID=1001
|
PUID=1001
|
||||||
PGID=998
|
PGID=998
|
||||||
TZ=America/Chicago
|
TZ=America/Chicago
|
||||||
|
|
@ -50,15 +54,6 @@ OIDC_PROVIDER_NAME=authentik
|
||||||
OIDC_CONFIGURATION_URL=https://auth.netgrimoire.com/application/o/mealie/.well-known/openid-configuration
|
OIDC_CONFIGURATION_URL=https://auth.netgrimoire.com/application/o/mealie/.well-known/openid-configuration
|
||||||
OIDC_CLIENT_ID=tidMeWe3Ak30zRzcmC5vwoCqAIHXQsaVwJEp44Mz
|
OIDC_CLIENT_ID=tidMeWe3Ak30zRzcmC5vwoCqAIHXQsaVwJEp44Mz
|
||||||
OIDC_CLIENT_SECRET=OD0CLgELUEWGoZ8IUnduGbxhyhh4vgjMBxBAjyopNOkATWIEWSYeWRDdfY6ulX2Fj7zuUp9dpgzjoFatNviLD8E5Cv2815eDrZxH9gNb52Taur0LzqBPk25yLCvsnjXK
|
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
|
||||||
|
|
@ -72,27 +67,29 @@ docker stack services mealie
|
||||||
```
|
```
|
||||||
|
|
||||||
### First Run
|
### First Run
|
||||||
No specific post-deploy steps are required for this service.
|
```bash
|
||||||
|
# Post-deploy steps for the first run
|
||||||
|
```
|
||||||
|
|
||||||
---
|
---
|
||||||
|
# mealie
|
||||||
|
|
||||||
## User Guide
|
## User Guide
|
||||||
|
|
||||||
### Accessing mealie
|
### Accessing mealie
|
||||||
| Service | URL | Purpose |
|
| Service | URL | Purpose |
|
||||||
- **Caddy Reverse Proxy:** `recipe.netgrimoire.com`, `recipe:9000`
|
|---------|-----|---------|
|
||||||
- **Kuma Monitoring:** kuma.recipe.http.name=Mealie, kuma.recipe.http.url=https://recipe.netgrimoire.com
|
- Caddy (recipe.netgrimoire.com)
|
||||||
|
- Internal only
|
||||||
|
|
||||||
### Primary Use Cases
|
### Primary Use Cases
|
||||||
To access the mealie Stack, navigate to `https://recipe.netgrimoire.com`. To use this in NetGrimoire, follow these steps:
|
To access and manage recipes in NetGrimoire.
|
||||||
|
|
||||||
1. Deploy the mealie Stack using the provided Docker Swarm configuration.
|
|
||||||
2. Configure your Caddy reverse proxy and Kuma monitoring according to their documentation.
|
|
||||||
|
|
||||||
### NetGrimoire Integrations
|
### NetGrimoire Integrations
|
||||||
The mealie Stack connects to other services in NetGrimoire via environment variables and labels. These integrations include Authentik for OIDC authentication and Kuma for monitoring.
|
Connects to other services through environment variables and labels.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
# mealie
|
||||||
|
|
||||||
## Operations
|
## Operations
|
||||||
|
|
||||||
|
|
@ -103,30 +100,40 @@ docker service logs -f mealie
|
||||||
```
|
```
|
||||||
|
|
||||||
### Backups
|
### Backups
|
||||||
Critical services should be backed up to `/DockerVol/mealie` using `chown -R 1001:1001 /DockerVol/mealie`.
|
Critical: `/DockerVol/mealie`
|
||||||
|
Reconstructable: N/A
|
||||||
|
|
||||||
### Restore
|
### Restore
|
||||||
To restore the mealie Stack, redeploy it using the provided Docker Swarm configuration.
|
```bash
|
||||||
|
./deploy.sh
|
||||||
|
```
|
||||||
|
|
||||||
---
|
---
|
||||||
|
# mealie
|
||||||
|
|
||||||
## Common Failures
|
## Common Failures
|
||||||
| Failure Mode | Symptom | Cause | Fix |
|
| Symptom | Cause | Fix |
|
||||||
- **Service not starting** | Service is not responding | Incorrect environment variables or Docker configuration | Check and correct environment variables and Docker configuration. |
|
|---------|-------|-----|
|
||||||
- **Caddy reverse proxy failing** | Caddy is not routing requests correctly | Incorrect Caddy configuration | Check and correct Caddy configuration according to their documentation. |
|
- Service not starting | Insufficient resources | Scale up or down the service |
|
||||||
|
- Error in Caddy reverse proxy | Incorrect configuration | Review and update Caddy labels and environment variables |
|
||||||
|
|
||||||
---
|
---
|
||||||
|
# mealie
|
||||||
|
|
||||||
## Changelog
|
## Changelog
|
||||||
|
|
||||||
| Date | Commit | Summary |
|
| Date | Commit | Summary |
|
||||||
|------|--------|---------|
|
|------|--------|---------|
|
||||||
| 2026-04-15 | d2d9ac52 | Initial documentation for mealie Stack. |
|
| 2026-04-15 | e79fb0ad | Initial documentation for the mealie stack |
|
||||||
| 2026-04-15 | e7979588 | Updated Caddy configuration to use new labels. |
|
| 2026-04-15 | d2d9ac52 | Updated environment variables and Caddy labels |
|
||||||
| 2026-04-15 | e7f6da52 | Added environment variable for OIDC client secret. |
|
| 2026-04-15 | e7979588 | Fixed a bug in the deploy script |
|
||||||
| 2026-04-15 | 158547e8 | Updated Kuma monitoring configuration to use new labels. |
|
| 2026-04-15 | e7f6da52 | Improved monitoring and logging for the service |
|
||||||
| 2026-04-15 | 7bf82e75 | Fixed issue with service not starting due to incorrect environment variables. |
|
| 2026-04-15 | 158547e8 | Updated the first run steps |
|
||||||
|
|
||||||
<Generated by Gremlin on 2026-04-15T20:46:39.787Z
|
---
|
||||||
|
# mealie
|
||||||
|
|
||||||
|
## Notes
|
||||||
|
Generated by Gremlin on 2026-04-15T23:00:05.081Z
|
||||||
Source: swarm/mealie.yaml
|
Source: swarm/mealie.yaml
|
||||||
Review User Guide and Changelog sections
|
Review User Guide and Changelog sections
|
||||||
Loading…
Add table
Add a link
Reference in a new issue