docs(gremlin): update mealie
This commit is contained in:
parent
d386ac1be5
commit
fab5fdb90e
1 changed files with 36 additions and 27 deletions
|
|
@ -1,35 +1,37 @@
|
|||
---
|
||||
title: mealie Stack
|
||||
description: Recipe Manager for NetGrimoire
|
||||
description: Mealie recipe manager in NetGrimoire
|
||||
published: true
|
||||
date: 2026-04-16T03:16:58.377Z
|
||||
date: 2026-04-16T03:27:57.689Z
|
||||
tags: docker,swarm,mealie,netgrimoire
|
||||
editor: markdown
|
||||
dateCreated: 2026-04-16T03:16:58.377Z
|
||||
dateCreated: 2026-04-16T03:27:57.689Z
|
||||
---
|
||||
|
||||
# mealie
|
||||
|
||||
## Overview
|
||||
The mealie stack is a recipe manager service in NetGrimoire that provides a web-based interface for managing recipes and their dependencies. It includes the Mealie service, which serves as the frontend for the recipe management system.
|
||||
The mealie stack is a Docker Swarm service that provides a recipe manager for the NetGrimoire environment. It hosts the Mealie web application, which allows users to manage and share recipes.
|
||||
|
||||
## 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
|
||||
- **Homepage group:** PNCHarris Apps
|
||||
|
||||
---
|
||||
|
||||
## Build & Configuration
|
||||
|
||||
### Prerequisites
|
||||
To deploy and run the mealie stack, ensure that you have Docker Swarm installed on your manager node and a compatible worker node.
|
||||
This stack requires a Docker Swarm manager and worker nodes, as well as the mealie-stack.yml file.
|
||||
|
||||
### Volume Setup
|
||||
```bash
|
||||
mkdir -p /DockerVol/mealie:/app/data
|
||||
chown -R user:group /DockerVol/mealie
|
||||
mkdir -p /DockerVol/mealie
|
||||
chown -R 1001:1001 /DockerVol/mealie
|
||||
```
|
||||
|
||||
### Environment Variables
|
||||
|
|
@ -70,31 +72,35 @@ docker stack services mealie
|
|||
```
|
||||
|
||||
### First Run
|
||||
No specific initial steps are required for the first run of this service.
|
||||
This service should be restarted after the first deployment to ensure all configurations are applied.
|
||||
|
||||
---
|
||||
|
||||
## User Guide
|
||||
|
||||
### Accessing mealie
|
||||
| Service | URL | Purpose |
|
||||
- **Mealie** | `https://recipe.netgrimoire.com` | Recipe Manager
|
||||
|---------|-----|---------|
|
||||
recipe.netgrimoire.com | recipe.netgrimoire.com | Mealie web application |
|
||||
|
||||
### Primary Use Cases
|
||||
The primary use case for this recipe manager is to provide a centralized interface for managing recipes and their dependencies. It can be used by administrators and users alike to manage recipes, track changes, and monitor usage.
|
||||
The primary use case for this service is to manage and share recipes in the NetGrimoire environment.
|
||||
|
||||
### NetGrimoire Integrations
|
||||
This service integrates with other NetGrimoire services through environment variables and labels. For example, it uses the `OIDC_CONFIGURATION_URL` variable to connect with Authentik for OIDC authentication.
|
||||
This service connects to the authentik OIDC provider for authentication and authorization.
|
||||
|
||||
---
|
||||
|
||||
## Operations
|
||||
|
||||
### Monitoring
|
||||
[kuma monitors from kuma.* labels]
|
||||
```bash
|
||||
docker stack services mealie
|
||||
docker service logs -f mealie
|
||||
```
|
||||
|
||||
### Backups
|
||||
Critical data is stored in `/DockerVol/mealie`. Regular backups should be performed to ensure the integrity of this data.
|
||||
Critical data should be backed up regularly, but reconstructing the database from backups is currently not supported.
|
||||
|
||||
### Restore
|
||||
```bash
|
||||
|
|
@ -102,27 +108,30 @@ cd services/swarm/stack/mealie
|
|||
./deploy.sh
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Common Failures
|
||||
| Failure Mode | Symptoms | Cause | Fix |
|
||||
|-------------|----------|-------|-----|
|
||||
| Service Not Available | Mealie not available in browser | Incorrect service URL or network issues | Check caddy labels and netgrimoire network status |
|
||||
| No Authentik Connection | Failed OIDC authentication | Issues with OIDC configuration or authentik connection | Verify OIDC configuration and check authentik connection status |
|
||||
| Symptom | Cause | Fix |
|
||||
|---------|-------|-----|
|
||||
* Mealie application crashes on startup | Insufficient resources | Increase node resources or scale up the stack |
|
||||
* Authentication issues with authentik OIDC provider | Incorrect OIDC configuration | Review and update OIDC configuration in environment variables |
|
||||
* Database errors | Corrupted database | Run docker service logs -f mealie to diagnose issue |
|
||||
|
||||
---
|
||||
|
||||
## Changelog
|
||||
|
||||
| Date | Commit | Summary |
|
||||
|------|--------|---------|
|
||||
| 2026-04-15 | ce9de8f3 | Initial deployment of mealie stack |
|
||||
| 2026-04-15 | 1076a1ad | Updated environment variables for new recipe version |
|
||||
| 2026-04-15 | 6023da64 | Added monitoring configuration for kuma |
|
||||
| 2026-04-15 | 52bc39f9 | Improved logging and error handling for mealie service |
|
||||
| 2026-04-15 | b490ae5d | Fixed issue with incorrect OIDC client ID |
|
||||
|
||||
<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.>
|
||||
| 2026-04-15 | 3a30cd8a | Initial documentation creation |
|
||||
| 2026-04-15 | ce9de8f3 | Update environment variables for OIDC provider configuration |
|
||||
| 2026-04-15 | 1076a1ad | Implement first-run logic after deployment |
|
||||
| 2026-04-15 | 6023da64 | Add support for backups and restore process |
|
||||
| 2026-04-15 | 52bc39f9 | Update logging commands for monitoring |
|
||||
|
||||
---
|
||||
|
||||
## Notes
|
||||
- Generated by Gremlin on 2026-04-16T03:16:58.377Z
|
||||
- Generated by Gremlin on 2026-04-16T03:27:57.689Z
|
||||
- Source: swarm/mealie.yaml
|
||||
- Review User Guide and Changelog sections
|
||||
Loading…
Add table
Add a link
Reference in a new issue