traveler/Netgrimoire
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs(gremlin): update mealie

Browse source
This commit is contained in:
traveler 2026-04-23 17:57:07 -05:00
parent 48e92456ff
commit 60b2f5b992
1 changed files with 46 additions and 60 deletions
Download patch file Download diff file Expand all files Collapse all files

106
Netgrimoire/Services/mealie/mealie.md
View file

@ -1,43 +1,45 @@
--- ---
title: mealie Stack title: mealie Stack
description: Recipe Manager for NetGrimoire description: Recipe Manager
published: true published: true
date: 2026-04-23T22:53:53.292Z date: 2026-04-23T22:53:56.270Z
tags: docker,swarm,mealie,netgrimoire tags: docker,swarm,mealie,netgrimoire
editor: markdown editor: markdown
dateCreated: 2026-04-23T22:53:53.292Z dateCreated: 2026-04-23T22:53:56.270Z
--- ---
# mealie # mealie
## Overview ## Overview
The mealie stack is a Docker Swarm-based service in NetGrimoire that provides a recipe manager interface for users to create and manage recipes. The primary services involved are the mealie service, which handles user authentication, recipe management, and API interactions. The mealie Stack is a Docker Swarm configuration for the mealie service in NetGrimoire, providing a recipe manager platform. It includes the main services such as Caddy reverse proxy and Uptime Kuma monitoring.
---
### Services Table
| Service | Image | Port | Role |
|---------|-----|-----|------|
- **Host:** docker4
- **Network:** netgrimoire
--- ---
## Architecture ## Architecture
| Service | Image | Port | Role | Exposed via: recipe.netgrimoire.com, recipe:9000
- **Host:** docker4 Homepage group: PNCHarris Apps
- **Network:** netgrimoire
- **Exposed via:** recipe:9000, recipe.netgrimoire.com
- **Homepage group:** PNCHarris Apps
--- ---
## Build & Configuration
### Prerequisites ### Prerequisites
No specific prerequisites for this stack. No specific prerequisites for this stack.
---
### Volume Setup ### Volume Setup
```bash ```bash
mkdir -p /DockerVol/mealie mkdir -p /DockerVol/mealie:/app/data
chown -R user:group /DockerVol/mealie chown -R 1981:1981 /DockerVol/mealie
``` ```
### Environment Variables ### Environment Variables
```bash ```bash
# generate: openssl rand -hex 32
PUID=1964 PUID=1964
PGID=1964 PGID=1964
TZ=America/Chicago TZ=America/Chicago
@ -60,6 +62,8 @@ OIDC_GROUPS_CLAIM=groups
OIDC_SCOPES_OVERRIDE=openid profile email OIDC_SCOPES_OVERRIDE=openid profile email
OIDC_USER_GROUP=mealie-users OIDC_USER_GROUP=mealie-users
OIDC_ADMIN_GROUP=mealie-admins OIDC_ADMIN_GROUP=mealie-admins
generate: openssl rand -hex 32
``` ```
### Deploy ### Deploy
@ -73,37 +77,33 @@ docker stack services mealie
``` ```
### First Run ### First Run
After the initial deployment, the user will be prompted to create a new recipe. This will allow them to start managing recipes and accessing their respective pages. No specific post-deploy steps for this service.
--- ---
### User Guide
## User Guide
### Accessing mealie ### Accessing mealie
| Service | URL | Purpose | | Service | URL | Purpose |
- **Host:** recipe.netgrimoire.com (Caddy) - Caddy Reverse Proxy: recipe.netgrimoire.com, recipe:9000
- **API Endpoints:**
### Primary Use Cases ### Primary Use Cases
To access the recipe manager, users should navigate to the homepage of NetGrimoire and click on the Mealie link. This will redirect them to the mealie service's login page. To access the recipe manager platform and use its features such as recipe management and authentication.
### NetGrimoire Integrations ### NetGrimoire Integrations
The mealie stack integrates with other services in NetGrimoire through environment variables and labels. Connects to other services in NetGrimoire through environment variables and labels.
--- ---
### Operations
## Operations
### Monitoring ### Monitoring
kuma monitors: kuma.* monitors from kuma.*
```bash ```bash
docker stack services mealie docker stack services mealie
<docker service logs commands> docker service logs -f mealie
``` ```
### Backups ### Backups
Critical: `/DockerVol/mealie` is used to store data, so backups are essential. Critical vs reconstructable /DockerVol/ paths. This section requires more information on backup strategy and recovery processes.
Reconstructable: No critical failure modes for this stack.
### Restore ### Restore
```bash ```bash
@ -112,40 +112,26 @@ cd services/swarm/stack/mealie
``` ```
--- ---
### Common Failures
## Common Failures | Failure Mode | Symptom | Cause | Fix |
| Symptom | Cause | Fix | |-------------|---------|------|-----|
- **Failed login attempts:** Incorrect credentials entered by users. 1. Caddy Error | No reverse proxy | Insufficient configuration or connection issues | Check and correct caddy configuration and ensure network connectivity.
- Cause: User enters incorrect username or password. 2. Mealie Crash | Service crashes | High CPU usage or memory leaks | Monitor system resources and optimize service configuration.
- Fix: Ensure user input is validated and correct credentials are used. 3. Network Issues | Connection dropped| Network failure or misconfiguration | Verify network configuration and check for any issues with Docker Swarm networking.
- **Recipe not loading:** Network connectivity issues between the mealie service and NetGrimoire.
- Cause: Network latency or DNS resolution issues.
- Fix: Check network connectivity and resolve any DNS resolution issues.
- **Caddy crashes:** Inability to start Caddy due to configuration errors or port conflicts.
- Cause: Configuration file issues, port conflicts with other services, etc.
- Fix: Review the Caddy configuration file and resolve any conflicts.
- **Database connection failures:** Issues connecting to the database due to misconfigured credentials or network connectivity.
- Cause: Incorrect database credentials, network latency, etc.
- Fix: Ensure correct database credentials are used and check for network connectivity issues.
--- ---
### Changelog
## Changelog | Date | Commit | Summary |
|----------|---------------|-------------------------------|
| 2026-04-23 | dcbfef14 | Initial documentation |
| 2026-04-23 | 587cd931 | Changes to caddy configuration |
| 2026-04-23 | d9692222 | Configuration update for OIDC |
| 2026-04-23 | 1551b298 | Environment variable updates |
| 2026-04-23 | 7af7f886 | Optimizations for service performance|
| 2026-04-23 | 475445eb | Updates to Docker Swarm config |
| Date | Commit | Summary | Generated by Gremlin on 2026-04-23T22:53:56.270Z
|------|--------|---------| Source: swarm/mealie.yaml
| 2026-04-23 | 587cd931 | Added initial documentation for mealie stack. | Review User Guide and Changelog sections
| 2026-04-23 | d9692222 | Updated Caddy configuration to resolve port conflicts. |
| 2026-04-23 | 1551b298 | Improved environment variable validation for recipe management. |
| 2026-04-23 | 7af7f886 | Enhanced security features for mealie service, including improved authentication and authorization. |
| 2026-04-23 | 475445eb | Implemented backup mechanism for mealie data in /DockerVol/mealie. |
<Summary of the evolution of this service based on the diffs above. If no diffs available, note that this is the initial documentation.]
This stack has been improved to include enhanced security features and a better backup mechanism.
---
## Notes
- Generated by Gremlin on 2026-04-23T22:53:53.292Z
- Source: swarm/mealie.yaml