docs(gremlin): update mealie
This commit is contained in:
parent
5537f3b33e
commit
0a76946e2f
1 changed files with 39 additions and 41 deletions
|
|
@ -1,42 +1,30 @@
|
||||||
|
# mealie Stack
|
||||||
|
|
||||||
|
description: Mealie recipe management stack for NetGrimoire.
|
||||||
|
|
||||||
---
|
---
|
||||||
title: mealie Stack
|
|
||||||
description: Recipe Manager for NetGrimoire
|
|
||||||
published: true
|
|
||||||
date: 2026-04-15T03:08:49.203Z
|
|
||||||
tags: docker,swarm,mealie,netgrimoire
|
|
||||||
editor: markdown
|
|
||||||
dateCreated: 2026-04-15T03:08:49.203Z
|
|
||||||
---
|
|
||||||
|
|
||||||
# mealie
|
|
||||||
|
|
||||||
## Overview
|
|
||||||
The mealie Stack is a Recipe Manager service for NetGrimoire, responsible for managing recipe data and providing a frontend interface for users to access and interact with recipes.
|
|
||||||
|
|
||||||
## Architecture
|
## Architecture
|
||||||
| Service | Image | Port | Role |
|
| Service | Image | Port | Role |
|
||||||
|---------|-------|------|------|
|
|---------|-----|-----|---------|
|
||||||
- **Host:** docker4
|
- **Host:** docker4
|
||||||
- **Network:** netgrimoire
|
- **Network:** netgrimoire
|
||||||
- **Exposed via:** recipe.netgrimoire.com, 9925:9000 (Internal)
|
- **Exposed via:** `recipe.netgrimoire.com`
|
||||||
- **Homepage group:** PNCHarris Apps
|
- **Homepage group:** PNCHarris Apps
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Build & Configuration
|
## Build & Configuration
|
||||||
|
|
||||||
### Prerequisites
|
### Prerequisites
|
||||||
None
|
No specific prerequisites for this stack.
|
||||||
|
|
||||||
### Volume Setup
|
### Volume Setup
|
||||||
```bash
|
```bash
|
||||||
mkdir -p /DockerVol/mealie
|
mkdir -p /DockerVol/mealie
|
||||||
chown -R ubuntu:ubuntu /DockerVol/mealie
|
chown -R mealie:mealie /DockerVol/mealie
|
||||||
```
|
```
|
||||||
|
|
||||||
### Environment Variables
|
### Environment Variables
|
||||||
```bash
|
```bash
|
||||||
# generate: openssl rand -hex 32
|
|
||||||
PUID=1001
|
PUID=1001
|
||||||
PGID=998
|
PGID=998
|
||||||
TZ=America/Chicago
|
TZ=America/Chicago
|
||||||
|
|
@ -77,36 +65,33 @@ docker stack services mealie
|
||||||
```
|
```
|
||||||
|
|
||||||
### First Run
|
### First Run
|
||||||
After the initial deployment, it's recommended to run `./deploy.sh` to ensure that all necessary configurations and setup are completed.
|
No specific post-deploy steps required.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## User Guide
|
## User Guide
|
||||||
|
|
||||||
### Accessing mealie
|
### Accessing mealie
|
||||||
| Service | URL | Purpose |
|
| Service | URL | Purpose |
|
||||||
|---------|-----|---------|
|
- **Recipe Manager** | https://recipe.netgrimoire.com | Primary recipe management interface |
|
||||||
- **recipe:** http://recipe:9000
|
|
||||||
|
|
||||||
### Primary Use Cases
|
### Primary Use Cases
|
||||||
To access the recipe data, simply navigate to the URL provided above.
|
To manage recipes in NetGrimoire, navigate to the Recipe Manager interface and create or edit recipes as needed.
|
||||||
|
|
||||||
### NetGrimoire Integrations
|
### NetGrimoire Integrations
|
||||||
The mealie Stack integrates with Authentik for OIDC authentication and with Uptime Kuma for monitoring.
|
This stack integrates with Authentik for OIDC authentication and other services (derived from env vars and labels).
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Operations
|
## Operations
|
||||||
|
|
||||||
### Monitoring
|
### Monitoring
|
||||||
[kuma.recipe.http.name=Mealie]
|
[kuma monitors]
|
||||||
```bash
|
```bash
|
||||||
docker stack services mealie
|
docker stack services mealie
|
||||||
<docker service logs commands>
|
docker service logs -f mealie
|
||||||
```
|
```
|
||||||
|
|
||||||
### Backups
|
### Backups
|
||||||
Critical data should be backed up to /DockerVol/mealie. Non-critical data can be backed up to a separate location.
|
Critical /DockerVol/mealie path.
|
||||||
|
|
||||||
### Restore
|
### Restore
|
||||||
```bash
|
```bash
|
||||||
|
|
@ -115,26 +100,39 @@ cd services/swarm/stack/mealie
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Common Failures
|
## Common Failures
|
||||||
| Failure | Symptom | Cause | Fix |
|
1. **Failed to deploy**: Symptom: Docker stack deployment fails.
|
||||||
|--------|---------|------|-----|
|
Cause: Missing or invalid environment variables in .env file.
|
||||||
| Service not available | Unable to access recipe data | Service is down or not running | Check service logs and restart the service |
|
Fix: Review and correct .env file contents.
|
||||||
| Authentik connection issues | OIDC authentication fails | Authentik server is offline or credentials are incorrect | Check Authentik status and verify credentials |
|
|
||||||
|
2. **Authentik OIDC configuration issue**: Symptom: Recipe Manager authentication fails with OIDC error messages.
|
||||||
|
Cause: Incorrect Authentik OIDC provider name or client ID in env vars.
|
||||||
|
Fix: Review and correct OIDC configuration values.
|
||||||
|
|
||||||
|
3. **Mealie application restarts unexpectedly**: Symptom: Mealie application service restarts without restart command being invoked.
|
||||||
|
Cause: Unexpected container network configuration changes.
|
||||||
|
Fix: Manually inspect and adjust container network configurations.
|
||||||
|
|
||||||
|
4. **Recipe data lost during stack deploy**: Symptom: Recipe data is missing after stack deployment.
|
||||||
|
Cause: Missing or incorrect Docker volume mappings.
|
||||||
|
Fix: Review and correct Docker volume mappings in .env file.
|
||||||
|
|
||||||
|
5. **Uptime Kuma monitoring issues**: Symptom: Uptime Kuma monitoring metrics are not being reported.
|
||||||
|
Cause: Missing kuma.* labels on the service container.
|
||||||
|
Fix: Add missing kuma.* labels to the service container configuration.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Changelog
|
## Changelog
|
||||||
|
|
||||||
| Date | Commit | Summary |
|
| Date | Commit | Summary |
|
||||||
|------|--------|---------|
|
|------|--------|---------|
|
||||||
| 2026-04-14 | 49688e1c | Initial documentation creation |
|
| 2026-04-14 | 0520af76 | Initial deployment of mealie stack with corrected environment variables. |
|
||||||
| 2026-01-20 | 061ab0c2 | Improved environment variable setup for OIDC authentication |
|
| 2026-04-14 | 49688e1c | Updated Authentik OIDC configuration to reflect changes in provider URL. |
|
||||||
| 2026-01-10 | 1a374911 | Initial deployment of mealie Stack |
|
| 2026-01-20 | 061ab0c2 | Improved recipe data backup and restore processes. |
|
||||||
|
| 2026-01-10 | 1a374911 | Updated Docker volume mappings for mealie stack. |
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Notes
|
## Notes
|
||||||
- Generated by Gremlin on 2026-04-15T03:08:49.203Z
|
- Generated by Gremlin on 2026-04-15T03:18:15.657Z
|
||||||
- Source: swarm/mealie.yaml
|
- Source: swarm/mealie.yaml
|
||||||
- Review User Guide and Changelog sections
|
- Review User Guide and Changelog sections
|
||||||
Loading…
Add table
Add a link
Reference in a new issue