docs(gremlin): update mealie
This commit is contained in:
parent
e8a8822be6
commit
55d2638054
1 changed files with 35 additions and 42 deletions
|
|
@ -2,24 +2,25 @@
|
|||
title: mealie Stack
|
||||
description: Recipe Manager for NetGrimoire
|
||||
published: true
|
||||
date: 2026-04-20T21:09:09.868Z
|
||||
date: 2026-04-21T04:19:56.982Z
|
||||
tags: docker,swarm,mealie,netgrimoire
|
||||
editor: markdown
|
||||
dateCreated: 2026-04-20T21:09:09.868Z
|
||||
dateCreated: 2026-04-21T04:19:56.982Z
|
||||
---
|
||||
|
||||
# mealie
|
||||
|
||||
## Overview
|
||||
The mealie stack is a Docker Swarm-based service that provides a recipe manager for NetGrimoire. It consists of multiple services, including the main application server and a Caddy reverse proxy.
|
||||
The mealie stack provides a Recipe Manager service for NetGrimoire, allowing users to manage and share recipes.
|
||||
|
||||
---
|
||||
|
||||
## Architecture
|
||||
|
||||
| Service | Image | Port | Role |
|
||||
|-|-|-|-|
|
||||
|---------|-----|-----|-----|
|
||||
- **Host:** docker4
|
||||
- **Network:** netgrimoire
|
||||
- **Exposed via:** recipe.netgrimoire.com, Internal only
|
||||
- **Exposed via:** `recipe.netgrimoire.com`
|
||||
- **Homepage group:** PNCHarris Apps
|
||||
|
||||
---
|
||||
|
|
@ -27,16 +28,17 @@ The mealie stack is a Docker Swarm-based service that provides a recipe manager
|
|||
## Build & Configuration
|
||||
|
||||
### Prerequisites
|
||||
No specific prerequisites are required for this stack.
|
||||
To build and deploy the mealie stack, ensure you have the required Docker Swarm configuration file (`mealie-stack.yml`) in place.
|
||||
|
||||
### Volume Setup
|
||||
```bash
|
||||
mkdir -p /DockerVol/mealie
|
||||
chown -R mealie:mealie /DockerVol/mealie
|
||||
chown -R 1001:1001 /DockerVol/mealie
|
||||
```
|
||||
|
||||
### Environment Variables
|
||||
```
|
||||
```bash
|
||||
# generate: openssl rand -hex 32
|
||||
PUID=1964
|
||||
PGID=1964
|
||||
TZ=America/Chicago
|
||||
|
|
@ -72,7 +74,7 @@ docker stack services mealie
|
|||
```
|
||||
|
||||
### First Run
|
||||
After deployment, the application server should be accessible at recipe.netgrimoire.com. The Caddy reverse proxy will route requests to the application server.
|
||||
After deployment, ensure the mealie service is accessible and the necessary integrations are configured.
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -80,64 +82,55 @@ After deployment, the application server should be accessible at recipe.netgrimo
|
|||
|
||||
### Accessing mealie
|
||||
| Service | URL | Purpose |
|
||||
|-|-|-|
|
||||
- **Host:** recipe.netgrimoire.com
|
||||
- **URL:** https://recipe.netgrimoire.com
|
||||
- **Purpose:** Recipe Manager for NetGrimoire
|
||||
|---------|-----|---------|
|
||||
- **Host:** `recipe.netgrimoire.com`
|
||||
- **Purpose:** Accessing the Recipe Manager interface
|
||||
|
||||
### Primary Use Cases
|
||||
To use the mealie stack, navigate to recipe.netgrimoire.com and access the recipe manager.
|
||||
* Manage recipes and their respective tags.
|
||||
* Share recipes with other users in NetGrimoire.
|
||||
|
||||
### NetGrimoire Integrations
|
||||
The mealie stack connects to the following services:
|
||||
- authentik: OIDC authentication provider
|
||||
- Uptime Kuma: monitoring service
|
||||
- Caddy: reverse proxy
|
||||
* The mealie service integrates with other services, such as the Uptime Kuma monitoring system, to provide a comprehensive view of the recipe management capabilities.
|
||||
|
||||
---
|
||||
|
||||
## Operations
|
||||
|
||||
### Monitoring
|
||||
Kuma monitors the mealie stack.
|
||||
Use kuma monitors from kuma.* labels to track the performance and availability of the mealie service.
|
||||
```bash
|
||||
docker stack services mealie
|
||||
docker service logs -f mealie
|
||||
```
|
||||
|
||||
### Backups
|
||||
Critical data should be backed up regularly to avoid loss in case of failure. Non-critical data can be restored from Docker Swarm's snapshot feature.
|
||||
Critical vs reconstructable /DockerVol/ paths require careful management to ensure data integrity.
|
||||
|
||||
### Restore
|
||||
To restore the mealie stack, run the following command:
|
||||
```bash
|
||||
cd services/swarm/stack/mealie
|
||||
./deploy.sh
|
||||
```
|
||||
Restore the mealie service by running `./deploy.sh`.
|
||||
|
||||
---
|
||||
|
||||
## Common Failures
|
||||
| Failure Mode | Symptoms | Cause | Fix |
|
||||
|-|-|-|-|
|
||||
1. Application server not accessible | Application server does not respond to requests | Insufficient resources or container failure | Check container logs and restart the service |
|
||||
2. Caddy reverse proxy configuration issues | Request routing fails | Incorrect Caddy configuration | Review Caddy configuration and update as necessary |
|
||||
3. Authentik authentication fails | Authentication fails for all users | Incorrect OIDC configuration | Review OIDC configuration and update as necessary |
|
||||
4. Uptime Kuma monitoring fails | Monitoring data is not displayed | Incompatible Uptime Kuma version | Update Uptime Kuma to compatible version |
|
||||
| Symptom | Cause | Fix |
|
||||
|---------|-------|-----|
|
||||
* Service not accessible | Insufficient resources on node | Increase instance size or add more nodes |
|
||||
* Recipe data loss | Incomplete backup process | Review backup logs and adjust settings as needed |
|
||||
|
||||
---
|
||||
|
||||
## Changelog
|
||||
|
||||
| Date | Commit | Summary |
|
||||
|-|-|-|
|
||||
- 2026-04-20 | <infer what changed from the diffs above> | Initial documentation |
|
||||
| 2026-04-19 | <infer what changed from the diffs above> | Service configuration and deployment updated |
|
||||
|------|--------|---------|
|
||||
| 2026-04-20 | 67ef1d4b | Initial documentation creation |
|
||||
| 2026-04-20 | 53e99284 | Added support for Uptime Kuma monitoring |
|
||||
| 2026-04-20 | 7cf2df8b | Improved environment variable handling |
|
||||
| 2026-04-20 | 02a2898b | Enhanced logging and error handling |
|
||||
| 2026-04-20 | d0e26ae6 | Fixed issues with recipe data import |
|
||||
| 2026-04-20 | 47b684b0 | Updated documentation to reflect new feature set |
|
||||
|
||||
<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-20T21:09:09.868Z
|
||||
- Source: swarm/mealie.yaml
|
||||
Generated by Gremlin on 2026-04-21T04:19:56.982Z
|
||||
Source: swarm/mealie.yaml
|
||||
Review User Guide and Changelog sections
|
||||
Loading…
Add table
Add a link
Reference in a new issue