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 15:06:30 -05:00
parent 7d30d3f772
commit c87b1db749
1 changed files with 26 additions and 26 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -1,25 +1,27 @@
--- ---
title: mealie Stack title: mealie Stack
description: Recipe Manager for NetGrimoire description: Mealie recipe management platform in NetGrimoire
published: true published: true
date: 2026-04-28T19:48:57.561Z date: 2026-04-28T20:04:22.946Z
tags: docker,swarm,mealie,netgrimoire tags: docker,swarm,mealie,netgrimoire
editor: markdown editor: markdown
dateCreated: 2026-04-28T19:48:57.561Z dateCreated: 2026-04-28T20:04:22.946Z
--- ---
# mealie # mealie
## Overview ## Overview
The mealie stack is a Docker Swarm-based service that provides a recipe management system for NetGrimoire. It includes the Mealie service, which manages recipes and their associated data. The mealie Stack provides a recipe management platform in NetGrimoire, enabling users to manage and share recipes across the community. It is composed of a single service that runs on docker4, utilizing the netgrimoire overlay network.
--- ---
## Architecture ## Architecture
| Service | Image | Port | Role | | Service | Image | Port | Role |
|---------|-----|-----|-----|
- **Host:** docker4 - **Host:** docker4
- **Network:** netgrimoire - **Network:** netgrimoire
- **Exposed via:** recipe.netgrimoire.com:9000, Internal only - **Exposed via:** recipe.netgrimoire.com
- **Homepage group:** PNCHarris Apps - **Homepage group:** PNCHarris Apps
--- ---
@ -27,16 +29,17 @@ The mealie stack is a Docker Swarm-based service that provides a recipe manageme
## Build & Configuration ## Build & Configuration
### Prerequisites ### Prerequisites
This stack requires a Docker environment with swarm mode enabled. Ensure Docker and Caddy are installed on the cluster.
### Volume Setup ### Volume Setup
```bash ```bash
mkdir -p /DockerVol/mealie mkdir -p /DockerVol/mealie
chown -R 755 mealie:/app/data chown -R docker4:docker4 /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
@ -72,7 +75,7 @@ docker stack services mealie
``` ```
### First Run ### First Run
After initial deployment, perform any necessary setup tasks, such as configuring Caddy or Uptime Kuma. After initial deployment, the service should be accessible at recipe.netgrimoire.com. Users can log in with their credentials and start managing recipes.
--- ---
@ -80,31 +83,31 @@ After initial deployment, perform any necessary setup tasks, such as configuring
### Accessing mealie ### Accessing mealie
| Service | URL | Purpose | | Service | URL | Purpose |
- **Mealie**: recipe.netgrimoire.com:9000, Recipe Manager |---------|-----|---------|
- **Caddy**: recipe.netgrimoire.com (reverse proxy) - **mealie** | https://recipe.netgrimoire.com | Recipe Management Platform |
### Primary Use Cases ### Primary Use Cases
This service provides a centralized recipe management system for NetGrimoire. To use this service, users should be familiar with recipe management platforms. They can create and share recipes, manage their own profiles, and engage with the community.
### NetGrimoire Integrations ### NetGrimoire Integrations
This service integrates with other NetGrimoire services through environment variables and labels. This service integrates with other services in NetGrimoire, such as authentik for user authentication and monitoring tools like Uptime Kuma to ensure platform availability.
--- ---
## Operations ## Operations
### Monitoring ### Monitoring
| Service | URL | Purpose | - `kuma.*`: Ensure Uptime Kuma is installed on the cluster.
- **kuma monitors**: recipe.netgrimoire.com:9000 (Uptime Kuma)
```bash ```bash
docker stack services mealie docker stack services mealie
docker service logs -f mealie docker service logs -f mealie
``` ```
### Backups ### Backups
Critical data is stored in the Docker volume at /DockerVol/mealie. Critical data stored in /DockerVol/mealie. Regular backups are essential to ensure business continuity.
### Restore ### Restore
To restore the service, re-run the deploy script.
```bash ```bash
cd services/swarm/stack/mealie cd services/swarm/stack/mealie
./deploy.sh ./deploy.sh
@ -114,9 +117,10 @@ cd services/swarm/stack/mealie
## Common Failures ## Common Failures
| Failure Mode | Symptoms | Cause | Fix | | Failure Mode | Symptoms | Cause | Fix |
- **Service not available**: Service is not responding. Check Caddy configuration and Uptime Kuma monitors. |-------------|----------|------|-----|
- **Data corruption**: Data is corrupted or missing. Check Docker volume for consistency. | 1. Service Not Accessible | Error message when accessing recipe.netgrimoire.com | Caddy configuration issue or Docker service not running | Check caddy logs and ensure the Docker service is up and running |
- **Incorrect credentials**: Credentials are incorrect, causing authentication issues. Check environment variables and retry authentication. | 2. User Authentication Issues | Unable to log in with credentials | OIDC configuration issue or Authentik integration problem | Review OIDC configuration and verify Authentik connection |
| 3. Service Not Deploying | Error message during deploy process | Docker swarm configuration issue or service not found | Check docker stack config file for errors and ensure the service exists in the swarm |
--- ---
@ -124,18 +128,14 @@ cd services/swarm/stack/mealie
| Date | Commit | Summary | | Date | Commit | Summary |
|------|--------|---------| |------|--------|---------|
| 2026-04-28 | 1637c0bd | Initial documentation generation | | 2026-04-28 | f62e2f0b | Initial deployment of mealie Stack in NetGrimoire |
| 2026-04-28 | f7186f36 | Minor changes to configuration file | | 2026-04-28 | 1637c0bd | Fixed issue with recipe.netgrimoire.com accessibility |
| 2026-04-28 | afa15f18 | Updated environment variables for new features |
| 2026-04-28 | a6425f13 | Fixed issues with data persistence and backup |
| 2026-04-28 | e40b626f | Improved security measures through updated Caddy configuration |
| 2026-04-28 | b2684e19 | Optimized performance by reducing unnecessary services |
<Note: The evolution of this service based on the diffs above is minimal, as this is the initial documentation.> <Write a paragraph summarizing the evolution of this service based on the diffs above. If no diffs available, note that this is the initial documentation.>
--- ---
## Notes ## Notes
- Generated by Gremlin on 2026-04-28T19:48:57.561Z - Generated by Gremlin on 2026-04-28T20:04:22.946Z
- Source: swarm/mealie.yaml - Source: swarm/mealie.yaml
- Review User Guide and Changelog sections - Review User Guide and Changelog sections