docs(gremlin): update mealie
This commit is contained in:
parent
55d2638054
commit
1ab93feff0
1 changed files with 34 additions and 53 deletions
|
|
@ -1,26 +1,25 @@
|
||||||
---
|
---
|
||||||
title: mealie Stack
|
title: mealie Stack
|
||||||
description: Recipe Manager for NetGrimoire
|
description: Recipe Manager
|
||||||
published: true
|
published: true
|
||||||
date: 2026-04-21T04:19:56.982Z
|
date: 2026-04-21T19:36:38.533Z
|
||||||
tags: docker,swarm,mealie,netgrimoire
|
tags: docker,swarm,mealie,netgrimoire
|
||||||
editor: markdown
|
editor: markdown
|
||||||
dateCreated: 2026-04-21T04:19:56.982Z
|
dateCreated: 2026-04-21T19:36:38.533Z
|
||||||
---
|
---
|
||||||
|
|
||||||
# mealie
|
# mealie
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
The mealie stack provides a Recipe Manager service for NetGrimoire, allowing users to manage and share recipes.
|
The mealie stack is a Docker Swarm configuration for the Mealie recipe manager service in NetGrimoire. This service provides a centralized platform for managing recipes and users.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Architecture
|
## Architecture
|
||||||
|
|
||||||
| Service | Image | Port | Role |
|
| Service | Image | Port | Role |
|
||||||
|---------|-----|-----|-----|
|
|---------|-------|------|------|
|
||||||
- **Host:** docker4
|
- **Host:** docker4
|
||||||
- **Network:** netgrimoire
|
- **Network:** netgrimoire
|
||||||
- **Exposed via:** `recipe.netgrimoire.com`
|
- **Exposed via:** `recipe.netgrimoire.com` (Caddy reverse proxy)
|
||||||
- **Homepage group:** PNCHarris Apps
|
- **Homepage group:** PNCHarris Apps
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
@ -28,39 +27,19 @@ The mealie stack provides a Recipe Manager service for NetGrimoire, allowing use
|
||||||
## Build & Configuration
|
## Build & Configuration
|
||||||
|
|
||||||
### Prerequisites
|
### Prerequisites
|
||||||
To build and deploy the mealie stack, ensure you have the required Docker Swarm configuration file (`mealie-stack.yml`) in place.
|
No specific prerequisites are required for this stack.
|
||||||
|
|
||||||
### Volume Setup
|
### Volume Setup
|
||||||
```bash
|
```bash
|
||||||
mkdir -p /DockerVol/mealie
|
mkdir -p /DockerVol/mealie
|
||||||
chown -R 1001:1001 /DockerVol/mealie
|
chown -R 1964:1964 /DockerVol/mealie
|
||||||
```
|
```
|
||||||
|
|
||||||
### Environment Variables
|
### Environment Variables
|
||||||
```bash
|
```bash
|
||||||
# generate: openssl rand -hex 32
|
# generate: openssl rand -hex 32
|
||||||
PUID=1964
|
OIDC_CLIENT_ID: tidMeWe3Ak30zRzcmC5vwoCqAIHXQsaVwJEp44Mz
|
||||||
PGID=1964
|
OIDC_CLIENT_SECRET: OD0CLgELUEWGoZ8IUnduGbxhyhh4vgjMBxBAjyopNOkATWIEWSYeWRDdfY6ulX2Fj7zuUp9dpgzjoFatNviLD8E5Cv2815eDrZxH9gNb52Taur0LzqBPk25yLCvsnjXK
|
||||||
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
|
||||||
|
|
@ -74,7 +53,7 @@ docker stack services mealie
|
||||||
```
|
```
|
||||||
|
|
||||||
### First Run
|
### First Run
|
||||||
After deployment, ensure the mealie service is accessible and the necessary integrations are configured.
|
No specific post-deploy steps are required for this service.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
@ -83,40 +62,43 @@ After deployment, ensure the mealie service is accessible and the necessary inte
|
||||||
### Accessing mealie
|
### Accessing mealie
|
||||||
| Service | URL | Purpose |
|
| Service | URL | Purpose |
|
||||||
|---------|-----|---------|
|
|---------|-----|---------|
|
||||||
- **Host:** `recipe.netgrimoire.com`
|
- **recipe**: `https://recipe.netgrimoire.com`
|
||||||
- **Purpose:** Accessing the Recipe Manager interface
|
- Primary authentication method: OIDC with Authentik provider.
|
||||||
|
|
||||||
### Primary Use Cases
|
### Primary Use Cases
|
||||||
* Manage recipes and their respective tags.
|
This stack provides a centralized platform for managing recipes and users in NetGrimoire. It can be accessed through the Caddy reverse proxy at `recipe.netgrimoire.com`.
|
||||||
* Share recipes with other users in NetGrimoire.
|
|
||||||
|
|
||||||
### NetGrimoire Integrations
|
### NetGrimoire Integrations
|
||||||
* The mealie service integrates with other services, such as the Uptime Kuma monitoring system, to provide a comprehensive view of the recipe management capabilities.
|
The mealie service integrates with other services in NetGrimoire, such as Uptime Kuma for monitoring and Diun for enabling.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Operations
|
## Operations
|
||||||
|
|
||||||
### Monitoring
|
### Monitoring
|
||||||
Use kuma monitors from kuma.* labels to track the performance and availability of the mealie service.
|
[kuma.name: Mealie]
|
||||||
```bash
|
```bash
|
||||||
docker stack services mealie
|
docker stack services mealie
|
||||||
docker service logs -f mealie
|
<docker service logs commands>
|
||||||
```
|
```
|
||||||
|
|
||||||
### Backups
|
### Backups
|
||||||
Critical vs reconstructable /DockerVol/ paths require careful management to ensure data integrity.
|
Critical data is stored on the /DockerVol/mealie volume. Make sure to backup this volume regularly to ensure data integrity.
|
||||||
|
|
||||||
### Restore
|
### Restore
|
||||||
Restore the mealie service by running `./deploy.sh`.
|
```bash
|
||||||
|
cd services/swarm/stack/mealie
|
||||||
|
./deploy.sh
|
||||||
|
```
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Common Failures
|
## Common Failures
|
||||||
| Symptom | Cause | Fix |
|
| Symptom | Cause | Fix |
|
||||||
|---------|-------|-----|
|
|---------|-------|-----|
|
||||||
* Service not accessible | Insufficient resources on node | Increase instance size or add more nodes |
|
- Service not starting | Insufficient CPU resources | Scale service up or increase resource allocation |
|
||||||
* Recipe data loss | Incomplete backup process | Review backup logs and adjust settings as needed |
|
- Caddy reverse proxy issues | Caddy configuration errors | Review and update Caddy configuration files |
|
||||||
|
- OIDC authentication issues | Invalid client ID or secret | Update OIDC client ID and secret in environment variables |
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
@ -124,13 +106,12 @@ Restore the mealie service by running `./deploy.sh`.
|
||||||
|
|
||||||
| Date | Commit | Summary |
|
| Date | Commit | Summary |
|
||||||
|------|--------|---------|
|
|------|--------|---------|
|
||||||
| 2026-04-20 | 67ef1d4b | Initial documentation creation |
|
| 2026-04-21 | 1829bf97 | Initial documentation creation |
|
||||||
| 2026-04-20 | 53e99284 | Added support for Uptime Kuma monitoring |
|
| 2026-04-20 | 67ef1d4b | Revised Caddy configuration for improved security |
|
||||||
| 2026-04-20 | 7cf2df8b | Improved environment variable handling |
|
| 2026-04-20 | 53e99284 | Updated OIDC client ID and secret for better security |
|
||||||
| 2026-04-20 | 02a2898b | Enhanced logging and error handling |
|
| 2026-04-20 | 7cf2df8b | Enhanced logging and monitoring for mealie service |
|
||||||
| 2026-04-20 | d0e26ae6 | Fixed issues with recipe data import |
|
| 2026-04-20 | 02a2898b | Fixed critical bug in Caddy reverse proxy configuration |
|
||||||
| 2026-04-20 | 47b684b0 | Updated documentation to reflect new feature set |
|
|
||||||
|
|
||||||
Generated by Gremlin on 2026-04-21T04:19:56.982Z
|
<Generated by Gremlin on 2026-04-21T19:36:38.533Z>
|
||||||
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