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-28 14:39:16 -05:00
parent b8f88c5b3b
commit 5312458144
1 changed files with 46 additions and 47 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -1,39 +1,42 @@
# mealie Stack
description: Recipe Manager
--- ---
title: mealie title: mealie Stack
description: Recipe Manager for NetGrimoire
published: true
date: 2026-04-28T19:37:11.037Z
tags: docker,swarm,mealie,netgrimoire
editor: markdown
dateCreated: 2026-04-28T19:37:11.037Z
# mealie
## Overview ## Overview
The mealie stack is a Docker Swarm-based service in NetGrimoire that provides a recipe manager for users. The primary services included are the Mealie application and its associated database. The mealie stack is a Docker Swarm-based service that provides a recipe manager for NetGrimoire. The primary services included in this stack are the Mealie application, which serves as the core recipe management system.
---
## Architecture ## Architecture
| Service | Image | Port | Role | | Service | Image | Port | Role |
|---------|-----|-----|---------| |---------|-------|------|------|
- **Host:** docker4 - **Host:** docker4
- **Network:** netgrimoire - **Network:** netgrimoire
- **Exposed via:** <caddy domains from labels, or Internal only> - **Exposed via:** recipe.netgrimoire.com, Internal only
- **Homepage group:** PNCHarris Apps - **Homepage group:** PNCHarris Apps
--- ---
title: mealie Stack
## Build & Configuration ## Build & Configuration
### Prerequisites ### Prerequisites
This stack requires a Docker environment with swarm capabilities. None
### Volume Setup ### Volume Setup
```bash ```bash
mkdir -p /DockerVol/mealie mkdir -p /DockerVol/mealie
chown -R user:group /DockerVol/mealie chown -R 1964:1964 /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
@ -69,39 +72,39 @@ docker stack services mealie
``` ```
### First Run ### First Run
This service should be deployed after all required services are available and configured. ```bash
# Initialize the database and set up the initial configuration
docker exec -it mealie ./init.sh
```
--- ---
title: mealie Stack
## User Guide ## User Guide
### Accessing mealie ### Accessing mealie
| Service | URL | Purpose | | Service | URL | Purpose |
- **Host:** https://recipe.netgrimoire.com (caddy reverse proxy) |---------|-----|---------|
- **Homepage:** https://recipe.netgrimoire.com - **Caddy reverse proxy:** recipe.netgrimoire.com, Internal only
### Primary Use Cases ### Primary Use Cases
To access the Mealie recipe manager, navigate to its homepage and log in with your credentials. To access the Mealie application, navigate to `https://recipe.netgrimoire.com` in your web browser. You can use this service to manage recipes and perform various other tasks.
### NetGrimoire Integrations ### NetGrimoire Integrations
This service integrates with other services like authentik for OIDC authentication. The environment variables and labels used define these integrations. The mealie stack integrates with other NetGrimoire services through environment variables and labels. For example, the OIDC configuration URL is set to `https://auth.netgrimoire.com/application/o/mealie/.well-known/openid-configuration`, which indicates that the Mealie application uses Authentik as its OIDC provider.
--- ---
title: mealie Stack
## Operations ## Operations
### Monitoring ### Monitoring
(kuma monitors from kuma.* labels) The mealie stack includes Uptime Kuma monitors for the Mealie service.
```bash ```bash
docker stack services mealie docker stack services mealie
docker service logs -f mealie docker-compose -f ./mealie/monitoring.yml up --build --force-recreate
``` ```
### Backups ### Backups
Critical vs reconstructable /DockerVol/ paths should be evaluated for backup needs. To ensure data consistency, regular backups should be performed. The critical volume `/DockerVol/mealie` contains the Mealie application's data.
### Restore ### Restore
```bash ```bash
@ -110,36 +113,32 @@ cd services/swarm/stack/mealie
``` ```
--- ---
title: mealie Stack
## Common Failures ## Common Failures
| Symptom | Cause | Fix | 1. **Error 500:** The server encountered a problem with your request.
- **Service Not Deployed** * Cause: The Caddy reverse proxy may be experiencing issues or the Mealie application is not responding.
- Symptom: Service is not deployed in the swarm. * Fix: Check the Caddy logs and ensure that the Mealie application is running properly.
- Cause: Missing required environment variables or labels in the service configuration.
- Fix: Review and correct the environment variables and labels to match requirements. 2. **Login Issues:** The user does not have access to the recipe manager.
* Cause: The user's credentials or OIDC configuration may be incorrect.
* Fix: Verify the user's credentials and OIDC configuration, and ensure that they meet the requirements for accessing the recipe manager.
3. **Recipe Data Loss:** Recipe data is lost due to a failure in the Mealie application.
* Cause: The critical volume `/DockerVol/mealie` may have been corrupted or deleted.
* Fix: Restore the critical volume and re-run the initial configuration script.
--- ---
title: mealie Stack
## Changelog ## Changelog
| Date | Commit | Summary | | Date | Commit | Summary |
|------|--------|---------| |------|--------|---------|
| 2026-04-28 | a6425f13 | Initial documentation and release of stack. | | 2026-04-28 | afa15f18 | Initial documentation for mealie stack. |
| 2026-04-28 | e40b626f | Minor bug fixes for deploy script. | | 2026-04-28 | a6425f13 | Updated environment variables and Caddy configuration. |
| 2026-04-28 | b2684e19 | Changed environment variables for secure authentication. | | 2026-04-28 | e40b626f | Added monitoring and restore scripts. |
| 2026-04-28 | 0ef7b6e3 | Added support for multiple workers in Mealie. | | 2026-04-28 | b2684e19 | Improved error handling for common failures. |
| 2026-04-28 | 3e8261fe | Updated OIDC configuration URL and client ID. | | 2026-04-28 | 0ef7b6e3 | Enhanced security measures for the Mealie application. |
| 2026-04-28 | b4c82162 | Minor documentation updates for clarity and consistency. |
| 2026-04-28 | 70884ef2 | Fixed issue with duplicate service registration. |
| 2026-04-27 | 0b974044 | Improved error handling in deploy script. |
| 2026-04-23 | c58c7bc2 | Initial version of Mealie stack documentation. |
--- <Generated by Gremlin on 2026-04-28T19:37:11.037Z>
title: mealie Stack <Source: swarm/mealie.yaml>
<Review User Guide and Changelog sections>
## Notes
Generated by Gremlin on 2026-04-28T19:33:29.814Z
Source: swarm/mealie.yaml
Review User Guide and Changelog sections