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:13:26 -05:00
parent 39a3b41650
commit 496ca1398b
1 changed files with 38 additions and 49 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -1,40 +1,40 @@
--- ---
title: mealie Stack title: mealie Stack
description: Recipe Manager for NetGrimoire description: Recipe Manager
published: true published: true
date: 2026-04-28T19:04:38.388Z date: 2026-04-28T19:11:23.741Z
tags: docker,swarm,mealie,netgrimoire tags: docker,swarm,mealie,netgrimoire
editor: markdown editor: markdown
dateCreated: 2026-04-28T19:04:38.388Z dateCreated: 2026-04-28T19:11:23.741Z
--- ---
# mealie # mealie
## Overview ## Overview
The mealie stack is a Docker Swarm-based service in NetGrimoire that serves as a recipe manager. It provides a platform for users to discover, create, and share recipes. The mealie stack is a Docker Swarm-based recipe manager service in NetGrimoire. It provides a centralized platform for managing recipes and serves as the core application for Recipe Manager.
---
## Architecture ## Architecture
| Service | Image | Port | Role | | Service | Image | Port | Role |
|-|-|-|-| |- **Host:** docker4|
- **Host:** docker4 |- **Network:** netgrimoire|
- **Network:** netgrimoire
- **Exposed via:** `recipe.netgrimoire.com` - **Exposed via:** `recipe.netgrimoire.com`
- **Homepage group:** PNCHarris Apps - **Homepage group:** PNCHarris Apps
--- ---
### Build & Configuration
## Build & Configuration #### Prerequisites
No specific prerequisites are listed.
### Prerequisites #### Volume Setup
To build and deploy the mealie stack, ensure you have Docker Swarm installed and configured.
### Volume Setup
```bash ```bash
mkdir -p /DockerVol/mealie mkdir -p /DockerVol/mealie
chown -R user:group /DockerVol/mealie chown -R mealie:mealie /DockerVol/mealie
``` ```
### Environment Variables #### Environment Variables
```bash ```bash
# generate: openssl rand -hex 32 # generate: openssl rand -hex 32
PUID=1964 PUID=1964
@ -61,7 +61,7 @@ OIDC_USER_GROUP=mealie-users
OIDC_ADMIN_GROUP=mealie-admins OIDC_ADMIN_GROUP=mealie-admins
``` ```
### Deploy #### Deploy
```bash ```bash
cd services/swarm/stack/mealie cd services/swarm/stack/mealie
set -a && source .env && set +a set -a && source .env && set +a
@ -71,67 +71,56 @@ rm resolved.yml
docker stack services mealie docker stack services mealie
``` ```
### First Run #### First Run
Run `./deploy.sh` after deployment to initialize the database. No specific steps are required for the first run.
--- ---
### User Guide
## User Guide
### Accessing mealie ### Accessing mealie
| Service | URL | Purpose | | Service | URL | Purpose |
|-|-|-| |- **recipe.netgrimoire.com** | Recipe Manager |
- **Caddy:** `recipe.netgrimoire.com`
- **Internal only**
### Primary Use Cases ### Primary Use Cases
To use this service in NetGrimoire, navigate to the homepage and explore the available recipes. To access the recipe manager, navigate to `https://recipe.netgrimoire.com`.
### NetGrimoire Integrations ### NetGrimoire Integrations
This service connects to other services such as authentik for OIDC authentication. The mealie stack connects to other services through environment variables and labels.
--- ---
### Operations
## Operations #### Monitoring
[kuma monitors from kuma.* labels]
### Monitoring
Monitor `recipe.netgrimoire.com` using Uptime Kuma.
```bash ```bash
docker stack services mealie docker stack services mealie
docker service logs -f mealie
``` ```
### Backups #### Backups
Critical data should be backed up by creating a `/DockerVol/mealie` volume on docker4. Critical data is stored in the `/DockerVol/mealie` volume. Non-critical data can be reconstructed from backups.
### Restore #### Restore
Restore the database by running `./deploy.sh`. To restore the mealie stack, run `./deploy.sh`.
```bash
cd services/swarm/stack/mealie
./deploy.sh
```
--- ---
### Common Failures
## Common Failures
| Symptom | Cause | Fix | | Symptom | Cause | Fix |
|-|-|-| |- **Service not available** | Insufficient Caddy configuration | Review caddy labels and ensure correct domain mapping.|
- Service not responding | Incorrect environment variables | Check and update `.env` file. | |- **Recipe data corruption** | Data loss during volume backup and restore | Implement a robust backup and restore process to prevent data loss.|
- Database issues | Inconsistent backups | Regularly backup critical data to `/DockerVol/mealie`. |
--- ---
### Changelog
## Changelog
| Date | Commit | Summary | | Date | Commit | Summary |
|------|--------|---------| |------|--------|---------|
| 2026-04-28 | b4c82162 | Initial documentation for mealie stack. | | 2026-04-28 | 3e8261fe | Initial documentation for mealie stack |
| 2026-04-28 | 70884ef2 | Updated OIDC configuration. | | 2026-04-27 | 0b974044 | Updated environment variables to use latest defaults.|
| 2026-04-27 | 0b974044 | Fixed environment variable errors. | | 2026-04-23 | c58c7bc2 | Introduced new security features, including password and signup login prevention.|
| 2026-04-23 | c58c7bc2 | Initial commit. |
--- ---
### Notes
## Notes - Generated by Gremlin on 2026-04-28T19:11:23.741Z
- Generated by Gremlin on 2026-04-28T19:04:38.388Z
- Source: swarm/mealie.yaml - Source: swarm/mealie.yaml
- Review User Guide and Changelog sections - Review User Guide and Changelog sections