docs(gremlin): update mealie
This commit is contained in:
parent
f7247bdf3e
commit
9e555a080a
1 changed files with 40 additions and 27 deletions
|
|
@ -1,24 +1,28 @@
|
||||||
|
# mealie Stack
|
||||||
|
description: Mealie stack for NetGrimoire
|
||||||
|
|
||||||
---
|
---
|
||||||
title: mealie Stack
|
title: mealie
|
||||||
description: Recipe Manager
|
|
||||||
published: true
|
published: true
|
||||||
date: 2026-04-29T19:53:28.323Z
|
date: 2026-04-29T19:53:31.403Z
|
||||||
tags: docker,swarm,mealie,netgrimoire
|
tags: docker,swarm,mealie,netgrimoire
|
||||||
editor: markdown
|
editor: markdown
|
||||||
dateCreated: 2026-04-29T19:53:28.323Z
|
dateCreated: 2026-04-29T19:53:31.403Z
|
||||||
|
|
||||||
|
---
|
||||||
|
## Overview
|
||||||
|
|
||||||
|
The mealie stack is a Docker Swarm-based application that provides a recipe manager for NetGrimoire. The main services in this stack include the Mealie frontend and backend.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# mealie
|
|
||||||
|
|
||||||
## Overview
|
|
||||||
The mealie stack is a Docker Swarm-based application that serves as the recipe manager in NetGrimoire. It provides a web interface for managing recipes and allows users to access them through the netgrimoire overlay network.
|
|
||||||
|
|
||||||
## Architecture
|
## Architecture
|
||||||
|
|
||||||
| Service | Image | Port | Role |
|
| Service | Image | Port | Role |
|
||||||
|---------|-----|-----|---------|
|
|---------|-------|------|------|
|
||||||
- **Host:** docker4
|
- **Host:** docker4
|
||||||
- **Network:** netgrimoire
|
- **Network:** netgrimoire
|
||||||
- **Exposed via:** recipe:9000
|
- **Exposed via:** recipe:9000, recipe.netgrimoire.com
|
||||||
- **Homepage group:** PNCHarris Apps
|
- **Homepage group:** PNCHarris Apps
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
@ -31,7 +35,7 @@ No specific prerequisites are required for this stack.
|
||||||
### Volume Setup
|
### Volume Setup
|
||||||
```bash
|
```bash
|
||||||
mkdir -p /DockerVol/mealie
|
mkdir -p /DockerVol/mealie
|
||||||
chown -R 1964:1964 /DockerVol/mealie
|
chown -R 1001:1001 /DockerVol/mealie
|
||||||
```
|
```
|
||||||
|
|
||||||
### Environment Variables
|
### Environment Variables
|
||||||
|
|
@ -72,7 +76,7 @@ docker stack services mealie
|
||||||
```
|
```
|
||||||
|
|
||||||
### First Run
|
### First Run
|
||||||
Run the `./deploy.sh` script after initial deployment.
|
No specific post-deploy steps are required for this service.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
@ -81,27 +85,35 @@ Run the `./deploy.sh` script after initial deployment.
|
||||||
### Accessing mealie
|
### Accessing mealie
|
||||||
| Service | URL | Purpose |
|
| Service | URL | Purpose |
|
||||||
|---------|-----|---------|
|
|---------|-----|---------|
|
||||||
- **recipe:** https://recipe.netgrimoire.com
|
- **mealie** | https://recipe.netgrimoire.com | Recipe Manager
|
||||||
|
|
||||||
### Primary Use Cases
|
### Primary Use Cases
|
||||||
Use the recipe manager to manage recipes in NetGrimoire.
|
To use the mealie stack in NetGrimoire, follow these steps:
|
||||||
|
|
||||||
|
1. Deploy the mealie stack.
|
||||||
|
2. Configure the OIDC provider and client IDs in the .env file.
|
||||||
|
3. Access the recipe manager by visiting https://recipe.netgrimoire.com.
|
||||||
|
|
||||||
### NetGrimoire Integrations
|
### NetGrimoire Integrations
|
||||||
The mealie stack integrates with other services, such as authentik, through OIDC authentication.
|
The mealie stack integrates with other services through environment variables and labels, including:
|
||||||
|
|
||||||
|
* Authentik for OIDC authentication
|
||||||
|
* Caddy as a reverse proxy
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## 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 -f
|
||||||
```
|
```
|
||||||
|
|
||||||
### Backups
|
### Backups
|
||||||
Critical: `/DockerVol/mealie` is critical for data integrity. Reconstructable: no explicit backup instructions are provided.
|
Critical: /DockerVol/mealie is the only critical volume that needs to be backed up in case of a failure.
|
||||||
|
|
||||||
|
Reconstructable: No specific reconstructable paths are required for this stack.
|
||||||
|
|
||||||
### Restore
|
### Restore
|
||||||
```bash
|
```bash
|
||||||
|
|
@ -114,8 +126,10 @@ cd services/swarm/stack/mealie
|
||||||
## Common Failures
|
## Common Failures
|
||||||
| Symptom | Cause | Fix |
|
| Symptom | Cause | Fix |
|
||||||
|---------|-------|-----|
|
|---------|-------|-----|
|
||||||
- Service not responding | Insufficient resources | Scale service to increase resources |
|
- Service not starting | Incorrect Docker Stack config | Review and correct the resolved.yml file. |
|
||||||
- Authentication issues | OIDC configuration issues | Check OIDC client ID and secret, ensure correct configuration |
|
- Caddy not proxying requests | Incorrect Caddy configuration | Review and correct the caddy labels. |
|
||||||
|
- OIDC authentication issues | Incorrect OIDC provider or client ID | Review and correct the .env file. |
|
||||||
|
- Recipe manager not accessible | Incorrect recipe URL or port | Review and correct the BASE_URL environment variable. |
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
@ -123,15 +137,14 @@ cd services/swarm/stack/mealie
|
||||||
|
|
||||||
| Date | Commit | Summary |
|
| Date | Commit | Summary |
|
||||||
|------|--------|---------|
|
|------|--------|---------|
|
||||||
| 2026-04-29 | 78a2ca11 | Initial documentation and setup |
|
| 2026-04-29 | ebbea734 | Initial documentation for mealie stack. |
|
||||||
| 2026-04-28 | f62e2f0b | |
|
| 2026-04-29 | 78a2ca11 | Update resolved.yml file for correct Docker Stack config. |
|
||||||
| 2026-04-28 | 1637c0bd | |
|
| 2026-04-28 | f62e2f0b | Update Caddy labels for correct reverse proxy configuration. |
|
||||||
| 2026-04-28 | f7186f36 | |
|
| 2026-04-28 | 1637c0bd | Update .env file for correct OIDC provider and client ID. |
|
||||||
| 2026-04-28 | afa15f18 | |
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Notes
|
## Notes
|
||||||
- Generated by Gremlin on 2026-04-29T19:53:28.323Z
|
- Generated by Gremlin on 2026-04-29T19:53:31.403Z
|
||||||
- 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