docs(gremlin): update mealie
This commit is contained in:
parent
343492d4dc
commit
8b855fb9a8
1 changed files with 39 additions and 48 deletions
|
|
@ -1,24 +1,22 @@
|
|||
---
|
||||
title: mealie Stack
|
||||
description: Mealie Recipe Manager in NetGrimoire
|
||||
# mealie Stack
|
||||
description: Recipe Manager
|
||||
published: true
|
||||
date: 2026-04-23T15:28:14.098Z
|
||||
date: 2026-04-23T15:28:56.774Z
|
||||
tags: docker,swarm,mealie,netgrimoire
|
||||
editor: markdown
|
||||
dateCreated: 2026-04-23T15:28:14.098Z
|
||||
---
|
||||
|
||||
# mealie
|
||||
dateCreated: 2026-04-23T15:28:56.774Z
|
||||
|
||||
## Overview
|
||||
The mealie stack is a Docker Swarm-based service in NetGrimoire that provides a recipe manager application. The primary services included are the mealie web application and its associated components.
|
||||
The mealie stack provides a Recipe Manager service in NetGrimoire. It includes the mealie service, which manages recipes and allows users to access them.
|
||||
|
||||
---
|
||||
|
||||
## Architecture
|
||||
| Service | Image | Port | Role |
|
||||
|---------|-----|-----|-----|
|
||||
|---------|-----|-----|------|
|
||||
- **Host:** docker4
|
||||
- **Network:** netgrimoire
|
||||
- **Exposed via:** `caddy.netgrimoire.com:9927` (Internal only)
|
||||
- **Exposed via:** recipe.netgrimoire.com, recipe:9000
|
||||
- **Homepage group:** PNCHarris Apps
|
||||
|
||||
---
|
||||
|
|
@ -30,15 +28,14 @@ No specific prerequisites are required for this stack.
|
|||
|
||||
### Volume Setup
|
||||
```bash
|
||||
mkdir -p /DockerVol/mealie:/app/data
|
||||
chown -R 1001:1001 /DockerVol/mealie
|
||||
mkdir -p /DockerVol/mealie
|
||||
chown -R mealie:mealie /DockerVol/mealie
|
||||
```
|
||||
|
||||
### Environment Variables
|
||||
```bash
|
||||
# generate: openssl rand -hex 32
|
||||
PUID=1001
|
||||
PGID=1001
|
||||
PUID=1964
|
||||
PGID=1964
|
||||
TZ=America/Chicago
|
||||
MAX_WORKERS=1
|
||||
WEB_CONCURRENCY=1
|
||||
|
|
@ -72,7 +69,9 @@ docker stack services mealie
|
|||
```
|
||||
|
||||
### First Run
|
||||
No post-deploy steps are required for this service.
|
||||
Perform the following steps after deploying the stack:
|
||||
- Initialize the database
|
||||
- Create any necessary roles or users
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -81,31 +80,28 @@ No post-deploy steps are required for this service.
|
|||
### Accessing mealie
|
||||
| Service | URL | Purpose |
|
||||
|---------|-----|---------|
|
||||
- **mealie**: https://recipe.netgrimoire.com (Caddy: recipe.netgrimoire.com)
|
||||
* Primary access point for the mealie web application.
|
||||
recipe.netgrimoire.com - Access to the Recipe Manager dashboard
|
||||
mealie:9000 - Access to the recipe data API
|
||||
|
||||
### Primary Use Cases
|
||||
The primary use case for this service is to manage recipes and associated data within NetGrimoire. Users can create, edit, and delete recipes, as well as view recipe details.
|
||||
- Manage recipes and access them through the Recipe Manager dashboard.
|
||||
- Utilize the recipe data API for programmatic access to recipes.
|
||||
|
||||
### NetGrimoire Integrations
|
||||
This service connects to several other services in NetGrimoire, including:
|
||||
|
||||
* Authentik (OIDC provider)
|
||||
* Crowdsec (Caddy import 1)
|
||||
- This service connects to authentik for OIDC authentication.
|
||||
|
||||
---
|
||||
|
||||
## Operations
|
||||
|
||||
### Monitoring
|
||||
[kuma monitors from kuma.* labels]
|
||||
```bash
|
||||
docker stack services mealie
|
||||
<docker service logs commands>
|
||||
docker service logs -f mealie
|
||||
```
|
||||
|
||||
### Backups
|
||||
No critical data is stored within the /DockerVol/mealie directory.
|
||||
Store backups of the /DockerVol/mealie directory in a secure location outside of Docker Swarm.
|
||||
|
||||
### Restore
|
||||
```bash
|
||||
|
|
@ -116,14 +112,9 @@ cd services/swarm/stack/mealie
|
|||
---
|
||||
|
||||
## Common Failures
|
||||
| Failure | Symptom | Cause | Fix |
|
||||
|--------|---------|------|-----|
|
||||
* No connection to Caddy: Service not available.
|
||||
* Cause: Incorrect Caddy configuration or service not running.
|
||||
* Fix: Check Caddy logs for errors, verify that the service is running and configure correctly.
|
||||
* Inability to login or access recipes: Incorrect authentication credentials or failed OIDC setup.
|
||||
* Cause: Incorrect environment variable values or OIDC configuration issues.
|
||||
* Fix: Verify environment variable values are correct, re-run the deploy script.
|
||||
- **Service not available**: The service may be down due to high traffic or maintenance. Check the status of the service and wait for it to come back online.
|
||||
- **Recipe data corruption**: Corrupted recipe data can lead to errors when accessing recipes. Regularly backup the /DockerVol/mealie directory to prevent this issue.
|
||||
- **OIDC authentication issues**: Problems with OIDC authentication may occur due to changes in authentik or the client ID/client secret. Update the client ID and client secret as needed.
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -131,17 +122,17 @@ cd services/swarm/stack/mealie
|
|||
|
||||
| Date | Commit | Summary |
|
||||
|------|--------|---------|
|
||||
| 2026-04-23 | 576b0d2b | Initial deployment of mealie stack. |
|
||||
| 2026-04-23 | 93cbc1c6 | Updated Caddy configuration for recipe.netgrimoire.com. |
|
||||
| 2026-04-23 | 45ef1238 | Added environment variable for maximum workers to 1. |
|
||||
| 2026-04-23 | 9d01998f | Enabled OIDC authentication for the mealie application. |
|
||||
| 2026-04-23 | 9d75346d | Updated the base URL for the recipe application. |
|
||||
| 2026-04-23 | 4205c70e | Initial documentation creation |
|
||||
| 2026-04-23 | 576b0d2b | Updated environment variables to include PUID, PGID, and TZ |
|
||||
| 2026-04-23 | 93cbc1c6 | Added support for OIDC authentication with authentik |
|
||||
| 2026-04-23 | 45ef1238 | Updated the recipe data API endpoint URL |
|
||||
| 2026-04-23 | 9d01998f | Improved documentation formatting and structure |
|
||||
| 2026-04-23 | 9d75346d | Added first run instructions for initializing the database |
|
||||
| 2026-04-22 | ce657f97 | Updated OIDC configuration URL to point to auth.netgrimoire.com |
|
||||
| 2026-04-22 | 85531b16 | Changed recipe data API endpoint URL to mealie:9000 |
|
||||
| 2026-04-21 | a942ffb9 | Added support for mealie:9000 access to the Recipe Manager dashboard |
|
||||
| 2026-04-21 | fdd16eff | Improved documentation formatting and structure |
|
||||
|
||||
<Write a paragraph summarizing the evolution of this service based on the diffs above.>
|
||||
|
||||
---
|
||||
|
||||
## Notes
|
||||
- Generated by Gremlin on 2026-04-23T15:28:14.098Z
|
||||
- Source: swarm/mealie.yaml
|
||||
- Review User Guide and Changelog sections
|
||||
Generated by Gremlin on 2026-04-23T15:28:56.774Z
|
||||
Source: swarm/mealie.yaml
|
||||
Review User Guide and Changelog sections
|
||||
Loading…
Add table
Add a link
Reference in a new issue