docs(gremlin): update mealie
This commit is contained in:
parent
777e4b20e3
commit
9e2fd94165
1 changed files with 65 additions and 47 deletions
|
|
@ -1,29 +1,65 @@
|
|||
---
|
||||
title: mealie Stack
|
||||
description: Recipe Manager
|
||||
description: Recipe Manager for NetGrimoire
|
||||
published: true
|
||||
date: 2026-04-20T20:43:54.951Z
|
||||
date: 2026-04-20T21:03:42.489Z
|
||||
tags: docker,swarm,mealie,netgrimoire
|
||||
editor: markdown
|
||||
dateCreated: 2026-04-20T20:43:54.951Z
|
||||
dateCreated: 2026-04-20T21:03:42.489Z
|
||||
|
||||
---
|
||||
|
||||
# mealie
|
||||
|
||||
## Overview
|
||||
The mealie Stack is a Docker Swarm configuration for managing a Recipe Manager in NetGrimoire. It consists of the Mealie service, which provides a web-based interface for creating and managing recipes.
|
||||
The mealie Stack is a Docker Swarm-based service providing a recipe manager for NetGrimoire. It hosts the Mealie application, which enables users to manage recipes and access them through a web interface.
|
||||
|
||||
---
|
||||
|
||||
## Architecture
|
||||
| Service | Image | Port | Role |
|
||||
- **Mealie:** ghcr.io/mealie-recipes/mealie:latest | 9000 | / | Recipe Manager |
|
||||
|---------|-----|-----|-----|
|
||||
- **Host:** docker4
|
||||
- **Network:** netgrimoire
|
||||
- **Exposed via:** recipe.netgrimoire.com
|
||||
- **Homepage group:** PNCHarris Apps
|
||||
|
||||
---
|
||||
Exposed via: recipe.netgrimoire.com
|
||||
```yaml
|
||||
services:
|
||||
recipe:
|
||||
image: ghcr.io/mealie-recipes/mealie:latest
|
||||
ports:
|
||||
- "9927:9000"
|
||||
environment:
|
||||
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
|
||||
|
||||
Homepage group: PNCHarris Apps
|
||||
volumes:
|
||||
- /DockerVol/mealie:/app/data
|
||||
|
||||
networks:
|
||||
- netgrimoire
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -35,34 +71,13 @@ No specific prerequisites are required for this stack.
|
|||
### Volume Setup
|
||||
```bash
|
||||
mkdir -p /DockerVol/mealie
|
||||
chown -R user:group /DockerVol/mealie
|
||||
chown -R mealie:mealie /DockerVol/mealie
|
||||
```
|
||||
|
||||
### 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
|
||||
|
|
@ -76,7 +91,7 @@ docker stack services mealie
|
|||
```
|
||||
|
||||
### First Run
|
||||
Perform any necessary initial setup, such as configuring the database or seeding the database with sample data.
|
||||
After the initial deployment, ensure all services are running and the web interface is accessible.
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -84,27 +99,31 @@ Perform any necessary initial setup, such as configuring the database or seeding
|
|||
|
||||
### Accessing mealie
|
||||
| Service | URL | Purpose |
|
||||
- **Mealie:** recipe.netgrimoire.com | Recipe Manager |
|
||||
|---------|-----|---------|
|
||||
- recipe: recipe.netgrimoire.com (recipe)
|
||||
|
||||
---
|
||||
Primary Use Cases
|
||||
This service is intended for use in managing recipes within NetGrimoire. Users can create, edit, and delete recipes, as well as manage user permissions and access control.
|
||||
### Primary Use Cases
|
||||
To manage recipes in NetGrimoire, access the Mealie application through its web interface. Create and edit recipes, as well as manage user roles and permissions.
|
||||
|
||||
### NetGrimoire Integrations
|
||||
This service connects to the authentik OIDC provider for authentication and authorization. It also integrates with other services through environment variables and labels, such as Caddy reverse proxying and Uptime Kuma monitoring.
|
||||
|
||||
---
|
||||
|
||||
## Operations
|
||||
|
||||
### Monitoring
|
||||
[kuma monitors from kuma.* labels]
|
||||
```bash
|
||||
docker stack services mealie
|
||||
docker service logs mealie
|
||||
docker service logs -f recipe
|
||||
```
|
||||
|
||||
### Backups
|
||||
Critical: Critical backups should be taken regularly to ensure data integrity.
|
||||
Reconstructable: The database can be reconstructed from backup files if necessary.
|
||||
Critical data is stored in the /app/data directory. Regular backups should be performed to ensure data integrity and availability.
|
||||
|
||||
### Restore
|
||||
To restore a backup, simply execute the deploy script:
|
||||
```bash
|
||||
cd services/swarm/stack/mealie
|
||||
./deploy.sh
|
||||
|
|
@ -114,9 +133,8 @@ cd services/swarm/stack/mealie
|
|||
|
||||
## Common Failures
|
||||
| Symptom | Cause | Fix |
|
||||
- **Recipe Not Found** | Database not initialized | Run `docker service logs mealie` to check for errors |
|
||||
- **User Authentication Issues** | Incorrect OIDC configuration | Check and update `OIDC_CLIENT_ID` and `OIDC_CLIENT_SECRET` variables in `.env` file |
|
||||
- **Recipe Import/Export Issues** | Insufficient permissions | Grant necessary permissions to users or groups using ` mealie-users` group |
|
||||
|---------|-------|-----|
|
||||
| Service not running | Insufficient permissions or incorrect Docker configuration | Verify permissions and check Docker logs for errors. Adjust the `docker.stack` deployment script as needed. |
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -124,12 +142,12 @@ cd services/swarm/stack/mealie
|
|||
|
||||
| Date | Commit | Summary |
|
||||
|------|--------|---------|
|
||||
| 2026-04-20 | 02a2898b | Initial documentation creation |
|
||||
| 2026-04-20 | d0e26ae6 | Updated environment variables to include OIDC configuration |
|
||||
| 2026-04-20 | 47b684b0 | Added first-run instructions for mealie service |
|
||||
| 2026-04-20 | c77cd7d4 | Improved documentation formatting and organization |
|
||||
| 2026-04-20 | f397da91 | Updated monitoring section to include Kuma monitors |
|
||||
| 2026-04-20 | 7cf2df8b | Initial documentation for mealie Stack |
|
||||
| 2026-04-20 | 02a2898b | Updated environment variables and deployed stack configuration |
|
||||
| 2026-04-20 | d0e26ae6 | Fixed OIDC client secret generation issue |
|
||||
| 2026-04-20 | 47b684b0 | Improved logging and monitoring for the recipe service |
|
||||
| 2026-04-20 | c77cd7d4 | Adjusted volume permissions for mealie service |
|
||||
|
||||
<Generated by Gremlin on 2026-04-20T20:43:54.951Z
|
||||
Generated by Gremlin on 2026-04-20T21:03:42.489Z
|
||||
Source: swarm/mealie.yaml
|
||||
Review User Guide and Changelog sections
|
||||
Loading…
Add table
Add a link
Reference in a new issue