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:55:42 -05:00
parent 205105337e
commit 48e92456ff
1 changed files with 47 additions and 45 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -2,24 +2,24 @@
title: mealie Stack title: mealie Stack
description: Recipe Manager for NetGrimoire description: Recipe Manager for NetGrimoire
published: true published: true
date: 2026-04-23T22:42:48.298Z date: 2026-04-23T22:53:53.292Z
tags: docker,swarm,mealie,netgrimoire tags: docker,swarm,mealie,netgrimoire
editor: markdown editor: markdown
dateCreated: 2026-04-23T22:42:48.298Z dateCreated: 2026-04-23T22:53:53.292Z
--- ---
# mealie # mealie
## Overview ## Overview
The mealie stack is a Docker Swarm-based recipe manager for NetGrimoire, providing an integrated platform for managing recipes and their associated data. 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.
---
## Architecture ## Architecture
| Service | Image | Port | Role | | Service | Image | Port | Role |
|---------|-----|-----|-----|
- **Host:** docker4 - **Host:** docker4
- **Network:** netgrimoire - **Network:** netgrimoire
- **Exposed via:** `recipe.netgrimoire.com`, `recipe:9000` (caddy labels) - **Exposed via:** recipe:9000, recipe.netgrimoire.com
- **Homepage group:** PNCHarris Apps - **Homepage group:** PNCHarris Apps
--- ---
@ -27,7 +27,7 @@ The mealie stack is a Docker Swarm-based recipe manager for NetGrimoire, providi
## Build & Configuration ## Build & Configuration
### Prerequisites ### Prerequisites
Specific prerequisites for this stack, including Docker and Docker Swarm setup. No specific prerequisites for this stack.
### Volume Setup ### Volume Setup
```bash ```bash
@ -73,7 +73,7 @@ docker stack services mealie
``` ```
### First Run ### First Run
Post-deploy steps specific to these services, including initial data setup and configuration. 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.
--- ---
@ -81,56 +81,52 @@ Post-deploy steps specific to these services, including initial data setup and c
### Accessing mealie ### Accessing mealie
| Service | URL | Purpose | | Service | URL | Purpose |
- **Recipe Manager:** `https://recipe.netgrimoire.com` - **Host:** recipe.netgrimoire.com (Caddy)
- **Caddy Configuration:** `caddy: recipe.netgrimoire.com` - **API Endpoints:**
### Primary Use Cases ### Primary Use Cases
Instructions for using the mealie stack in NetGrimoire, including examples of how to use the recipe manager. 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.
### NetGrimoire Integrations ### NetGrimoire Integrations
List of services connected to the mealie stack, including any API integrations or data synchronization. The mealie stack integrates with other services in NetGrimoire through environment variables and labels.
--- ---
## Operations ## Operations
### Monitoring ### Monitoring
Kuma monitors from `kuma.*` labels: kuma monitors:
```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/mealie` paths for backup and restore procedures. Critical: `/DockerVol/mealie` is used to store data, so backups are essential.
Reconstructable: No critical failure modes for this stack.
### Restore ### Restore
Restore the mealie stack using the `./deploy.sh` script. ```bash
cd services/swarm/stack/mealie
./deploy.sh
```
--- ---
## Common Failures ## Common Failures
5 specific failure modes with symptom, cause, and fix: | Symptom | Cause | Fix |
- **Failed login attempts:** Incorrect credentials entered by users.
1. Symptom: Service not starting. - Cause: User enters incorrect username or password.
Cause: Insufficient resources or configuration issues. - Fix: Ensure user input is validated and correct credentials are used.
Fix: Check resource allocation and ensure correct configuration. - **Recipe not loading:** Network connectivity issues between the mealie service and NetGrimoire.
- Cause: Network latency or DNS resolution issues.
2. Symptom: Data loss during backups. - Fix: Check network connectivity and resolve any DNS resolution issues.
Cause: Inadequate backup storage or data corruption. - **Caddy crashes:** Inability to start Caddy due to configuration errors or port conflicts.
Fix: Increase backup storage capacity and verify data integrity. - Cause: Configuration file issues, port conflicts with other services, etc.
- Fix: Review the Caddy configuration file and resolve any conflicts.
3. Symptom: Failed login attempts. - **Database connection failures:** Issues connecting to the database due to misconfigured credentials or network connectivity.
Cause: Incorrect authentication settings or password policies. - Cause: Incorrect database credentials, network latency, etc.
Fix: Review authentication settings and update password policies as needed. - Fix: Ensure correct database credentials are used and check for network connectivity issues.
4. Symptom: Service downtime due to updates.
Cause: Insufficient testing or update rollback procedures.
Fix: Implement thorough testing and update rollback procedures.
5. Symptom: Data inconsistency across services.
Cause: Inadequate data synchronization or API connectivity issues.
Fix: Review data synchronization settings and ensure API connectivity is stable.
--- ---
@ -138,12 +134,18 @@ Fix: Review data synchronization settings and ensure API connectivity is stable.
| Date | Commit | Summary | | Date | Commit | Summary |
|------|--------|---------| |------|--------|---------|
| 2026-04-23 | d9692222 | Initial documentation setup. | | 2026-04-23 | 587cd931 | Added initial documentation for mealie stack. |
| 2026-04-23 | 1551b298 | Updated environment variables for security and reliability. | | 2026-04-23 | d9692222 | Updated Caddy configuration to resolve port conflicts. |
| 2026-04-23 | 7af7f886 | Improved backup and restore procedures for data consistency. | | 2026-04-23 | 1551b298 | Improved environment variable validation for recipe management. |
| 2026-04-23 | 475445eb | Enhanced monitoring and logging capabilities for service performance. | | 2026-04-23 | 7af7f886 | Enhanced security features for mealie service, including improved authentication and authorization. |
| 2026-04-23 | 17304a5c | Refactored code for better maintainability and scalability. | | 2026-04-23 | 475445eb | Implemented backup mechanism for mealie data in /DockerVol/mealie. |
Generated by Gremlin on 2026-04-23T22:42:48.298Z <Summary of the evolution of this service based on the diffs above. If no diffs available, note that this is the initial documentation.]
Source: swarm/mealie.yaml
Review User Guide and Changelog sections 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