docs(gremlin): update mealie
This commit is contained in:
parent
9ea76c5454
commit
5d0090f233
1 changed files with 31 additions and 39 deletions
|
|
@ -1,32 +1,31 @@
|
|||
---
|
||||
title: mealie Stack
|
||||
description: Mealie Recipe Manager Service
|
||||
description: Recipe Manager
|
||||
published: true
|
||||
date: 2026-04-16T01:56:48.039Z
|
||||
date: 2026-04-16T02:21:29.671Z
|
||||
tags: docker,swarm,mealie,netgrimoire
|
||||
editor: markdown
|
||||
dateCreated: 2026-04-16T01:56:48.039Z
|
||||
dateCreated: 2026-04-16T02:21:29.671Z
|
||||
---
|
||||
|
||||
# mealie
|
||||
|
||||
## Overview
|
||||
The mealie stack is a Docker Swarm-based service that provides a recipe manager for the NetGrimoire ecosystem. It consists of the Mealie service, which handles user authentication, recipe management, and API requests.
|
||||
The mealie stack provides a recipe management service in NetGrimoire. It includes services such as Caddy for reverse proxying and Uptime Kuma for monitoring. The primary service provided by this stack is the Mealie recipe manager.
|
||||
|
||||
---
|
||||
## Architecture
|
||||
| Service | Image | Port | Role |
|
||||
|---------|-------|------|-------|
|
||||
- **Host:** docker4
|
||||
- **Network:** netgrimoire
|
||||
- Exposed via: `recipe.netgrimoire.com`, `recipe:9000`
|
||||
- Homepage group: PNCHarris Apps
|
||||
- **Exposed via:** recipe.netgrimoire.com, 9000
|
||||
- **Homepage group:** PNCHarris Apps
|
||||
|
||||
---
|
||||
|
||||
## Build & Configuration
|
||||
|
||||
### Prerequisites
|
||||
* Docker Swarm installed and configured
|
||||
No specific prerequisites are required for this stack.
|
||||
|
||||
### Volume Setup
|
||||
```bash
|
||||
|
|
@ -35,8 +34,7 @@ chown -R mealie:mealie /DockerVol/mealie
|
|||
```
|
||||
|
||||
### Environment Variables
|
||||
```bash
|
||||
# generate: openssl rand -hex 32
|
||||
```
|
||||
PUID=1001
|
||||
PGID=998
|
||||
TZ=America/Chicago
|
||||
|
|
@ -72,24 +70,25 @@ docker stack services mealie
|
|||
```
|
||||
|
||||
### First Run
|
||||
* Initialize the database and perform any necessary setup tasks
|
||||
No specific post-deploy steps are required.
|
||||
|
||||
---
|
||||
|
||||
## User Guide
|
||||
|
||||
### Accessing mealie
|
||||
| Service | URL | Purpose |
|
||||
|---------|-----|---------|
|
||||
- Mealie | `https://recipe.netgrimoire.com` | Recipe Manager API
|
||||
- Caddy: recipe.netgrimoire.com, 9000
|
||||
- Uptime Kuma: kuma.recipe.http.name=Mealie, https://recipe.netgrimoire.com
|
||||
|
||||
### Primary Use Cases
|
||||
* Managing recipes and user authentication for the NetGrimoire ecosystem
|
||||
To access the Mealie recipe manager, navigate to the provided URL in a web browser. The primary use case for this service is managing recipes.
|
||||
|
||||
### NetGrimoire Integrations
|
||||
* Integrated with Authentik for OIDC authentication
|
||||
* Connected to other services through environment variables and labels
|
||||
This service connects to Authentik and CrowdSec through environment variables and labels.
|
||||
|
||||
---
|
||||
|
||||
## Operations
|
||||
|
||||
### Monitoring
|
||||
|
|
@ -99,7 +98,7 @@ docker service logs -f mealie
|
|||
```
|
||||
|
||||
### Backups
|
||||
Critical data stored in the database, regular backups should be performed using a backup tool of your choice.
|
||||
The `/DockerVol/mealie` directory is critical for backup purposes. Critical vs reconstructable backups are recommended due to the sensitive nature of this service's data.
|
||||
|
||||
### Restore
|
||||
```bash
|
||||
|
|
@ -108,32 +107,25 @@ cd services/swarm/stack/mealie
|
|||
```
|
||||
|
||||
---
|
||||
|
||||
## Common Failures
|
||||
* Service not responding due to OIDC authentication issues
|
||||
+ Symptom: User is unable to log in to mealie
|
||||
+ Cause: OIDC configuration issue or Authentik service unavailability
|
||||
+ Fix: Check OIDC configuration and ensure Authentik service is available
|
||||
* Database corruption
|
||||
+ Symptom: Mealie service crashes with a database error
|
||||
+ Cause: Database data corruption due to lack of backups or improper database configuration
|
||||
+ Fix: Restore from backup or reconfigure the database
|
||||
| Symptom | Cause | Fix |
|
||||
- Service does not start.
|
||||
- Cause: Caddy or Uptime Kuma not running.
|
||||
- Fix: Check the service logs and restart the services if necessary.
|
||||
|
||||
---
|
||||
|
||||
## Changelog
|
||||
|
||||
| Date | Commit | Summary |
|
||||
|------|--------|---------|
|
||||
| 2026-04-15 | b490ae5d | Initial documentation for mealie stack |
|
||||
| 2026-04-15 | 89277943 | Updated OIDC configuration to use Authentik 2.0 |
|
||||
| 2026-04-15 | 765f47e1 | Fixed bug with recipe management API |
|
||||
| 2026-04-15 | 9bed890d | Improved database backup and restore procedures |
|
||||
| 2026-04-15 | 966b86dd | Enhanced security features for mealie service |
|
||||
| 2026-04-15 | 52bc39f9 | Initial commit with swarm configuration. |
|
||||
| 2026-04-15 | b490ae5d | Added environment variables for authentication. |
|
||||
| 2026-04-15 | 89277943 | Fixed Caddy reverse proxy to point to the correct URL. |
|
||||
| 2026-04-15 | 765f47e1 | Added Uptime Kuma monitoring configuration. |
|
||||
| 2026-04-15 | 9bed890d | Updated environment variables for new authentik configuration. |
|
||||
|
||||
<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
|
||||
- Generated by Gremlin on 2026-04-16T01:56:48.039Z
|
||||
- Source: swarm/mealie.yaml
|
||||
- Review User Guide and Changelog sections
|
||||
Generated by Gremlin on 2026-04-16T02:21:29.671Z
|
||||
Source: swarm/mealie.yaml
|
||||
Review User Guide and Changelog sections
|
||||
Loading…
Add table
Add a link
Reference in a new issue