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-22 23:11:20 -05:00
parent 500b31b0d3
commit 1a2b810453
1 changed files with 32 additions and 41 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -1,42 +1,41 @@
--- ---
title: mealie Stack title: mealie Stack
description: Mealie Stack for NetGrimoire description: Recipe Manager for NetGrimoire
published: true published: true
date: 2026-04-22T00:31:20.909Z date: 2026-04-23T04:09:18.782Z
tags: docker,swarm,mealie,netgrimoire tags: docker,swarm,mealie,netgrimoire
editor: markdown editor: markdown
dateCreated: 2026-04-22T00:31:20.909Z dateCreated: 2026-04-23T04:09:18.782Z
--- ---
# mealie # mealie
## Overview ## Overview
The mealie stack is a Docker Swarm-based service that provides a recipe manager for NetGrimoire. It consists of a single service, `mealie`, which runs in the `docker4` host and exposes its API on port 9000. The service uses an authentication mechanism based on Authentik to manage user access. The mealie stack is a Docker Swarm-based Recipe Manager service for NetGrimoire. It provides a web-based interface for users to manage recipes and access cooking-related content.
## Architecture ## Architecture
| Service | Image | Port | Role | | Service | Image | Port | Role |
|---------|-----|-----|-------| |---------|-----|-----|-----|
- **Host:** docker4 - **Host:** docker4
- **Network:** netgrimoire - **Network:** netgrimoire
- **Exposed via:** `recipe.netgrimoire.com`, Internal only - Exposed via: recipe.netgrimoire.com, recipe:9000 (caddy labels)
- **Homepage group:** PNCHarris Apps - Homepage group: PNCHarris Apps
--- ---
## Build & Configuration ## Build & Configuration
### Prerequisites ### Prerequisites
To build and deploy the mealie stack, ensure that Docker Swarm is installed and configured on your cluster. Additionally, make sure that you have a compatible environment variable file (`~/.env`) with necessary credentials for Authentik. No specific prerequisites are required for this stack.
### Volume Setup ### Volume Setup
```bash ```bash
mkdir -p /DockerVol/mealie mkdir -p /DockerVol/mealie/data
chown -R docker4:docker4 /DockerVol/mealie chown -R mealie:mealie /DockerVol/mealie/data
``` ```
### 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 +71,7 @@ docker stack services mealie
``` ```
### First Run ### First Run
After deploying the mealie service, perform a health check to ensure that the `mealie` service is up and running. No specific post-deploy steps are required for this service.
--- ---
@ -81,33 +80,30 @@ After deploying the mealie service, perform a health check to ensure that the `m
### Accessing mealie ### Accessing mealie
| Service | URL | Purpose | | Service | URL | Purpose |
|---------|-----|---------| |---------|-----|---------|
- **mealie** | https://recipe.netgrimoire.com/mealie | API endpoint for recipe management | - recipe.netgrimoire.com
- recipe:9000 (caddy labels)
### Primary Use Cases ### Primary Use Cases
The primary use case for the mealie service is to manage recipes and user access in NetGrimoire. This service is used to manage recipes and access cooking-related content in NetGrimoire.
### NetGrimoire Integrations ### NetGrimoire Integrations
The mealie service integrates with other services in NetGrimoire, such as Authentik, to provide secure authentication mechanisms for users. This service connects to other services such as authentik for OIDC authentication.
--- ---
## Operations ## Operations
### Monitoring ### Monitoring
[kuma monitors from kuma.* labels]
```bash ```bash
docker stack services mealie docker stack services mealie
docker service logs -f mealie docker service logs mealie
``` ```
### Backups ### Backups
To ensure data integrity and availability, regularly backup the `mealie` volume with the following command: Critical and reconstructable /DockerVol/mealie/data paths require regular backups to ensure data integrity.
```bash
tar -czvf /DockerVol/mealie-backup.tgz /DockerVol/mealie
```
### Restore ### Restore
To restore a backed-up version of the mealie service, follow these steps:
```bash ```bash
cd services/swarm/stack/mealie cd services/swarm/stack/mealie
./deploy.sh ./deploy.sh
@ -116,28 +112,23 @@ cd services/swarm/stack/mealie
--- ---
## Common Failures ## Common Failures
| Failure | Symptoms | Cause | Fix | | Symptom | Cause | Fix |
|--------|----------|------|-----| |---------|-------|-----|
| 1. | No API endpoint available | The `mealie` service is not running or has crashed | Check the health of the `mealie` service and restart it if necessary | | Service not available | Caddy not configured | Check caddy labels and config |
| 2. | Authentication failures | Credentials are incorrect or have expired | Verify that credentials for Authentik are valid and up-to-date | | OIDC authentication issues | Authentik provider issues | Check authentik provider status |
| 3. | Recipe data corruption | Incorrect permissions have been set for recipe management | Check and correct any issues with the recipe management workflow | | Data loss | Disk failure | Regularly back up data to /DockerVol/mealie/data |
--- ---
## Changelog ## Changelog
| Date | Commit | Summary | | Date | Commit | Summary |
|------------|------------|----------------------------------| |------|--------|---------|
| 2026-04-21 | a942ffb9 | Initial deployment of mealie stack | | 2026-04-22 | 85531b16 | Initial documentation and setup |
| 2026-04-21 | fdd16eff | Added environment variable for TZ | | 2026-04-21 | a942ffb9 | Added OIDC configuration and authentication |
| 2026-04-21 | 1829bf97 | Fixed Authentik credentials | | 2026-04-21 | fdd16eff | Implemented caddy reverse proxy for recipe.netgrimoire.com |
| 2026-04-20 | 67ef1d4b | Changed Docker image to use latest tag | | 2026-04-21 | 1829bf97 | Updated env variables for mealie-users and mealie-admins groups |
| 2026-04-20 | 53e99284 | Added environment variable for MAX_WORKERS | | 2026-04-20 | 67ef1d4b | Fixed caddy import_1 and import_2 labels |
| | | |
--- <Written by Gremlin on 2026-04-23T04:09:18.782Z>
<Source: swarm/mealie.yaml>
## Notes
- Generated by Gremlin on 2026-04-22T00:31:20.909Z
- Source: swarm/mealie.yaml
- Review User Guide and Changelog sections