docs(gremlin): update mealie
This commit is contained in:
parent
f0bffb3197
commit
9ea76c5454
1 changed files with 39 additions and 45 deletions
|
|
@ -1,37 +1,37 @@
|
||||||
---
|
---
|
||||||
title: mealie Stack
|
title: mealie Stack
|
||||||
description: Mealie Recipe Manager in NetGrimoire
|
description: Mealie Recipe Manager Service
|
||||||
published: true
|
published: true
|
||||||
date: 2026-04-16T01:44:00.736Z
|
date: 2026-04-16T01:56:48.039Z
|
||||||
tags: docker,swarm,mealie,netgrimoire
|
tags: docker,swarm,mealie,netgrimoire
|
||||||
editor: markdown
|
editor: markdown
|
||||||
dateCreated: 2026-04-16T01:44:00.736Z
|
dateCreated: 2026-04-16T01:56:48.039Z
|
||||||
---
|
---
|
||||||
|
|
||||||
# mealie
|
# mealie
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
The mealie stack provides a recipe manager service for NetGrimoire, utilizing the Mealie platform to manage recipes. It features a frontend for creating and editing recipes, as well as an API for integrating with other services.
|
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.
|
||||||
|
|
||||||
## Architecture
|
|
||||||
| Service | Image | Port | Role |
|
|
||||||
|---------|-----|-----|------|
|
|
||||||
- **Host:** docker4
|
|
||||||
- **Network:** netgrimoire
|
|
||||||
- **Exposed via:** recipe:9000, recipe:9925 (caddy domains from labels)
|
|
||||||
- **Homepage group:** PNCHarris Apps
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
## Architecture
|
||||||
|
| Service | Image | Port | Role |
|
||||||
|
|---------|-------|------|-------|
|
||||||
|
- **Host:** docker4
|
||||||
|
- **Network:** netgrimoire
|
||||||
|
- Exposed via: `recipe.netgrimoire.com`, `recipe:9000`
|
||||||
|
- Homepage group: PNCHarris Apps
|
||||||
|
|
||||||
|
---
|
||||||
## Build & Configuration
|
## Build & Configuration
|
||||||
|
|
||||||
### Prerequisites
|
### Prerequisites
|
||||||
To build the mealie stack, ensure Docker and Docker Swarm are installed on your system.
|
* Docker Swarm installed and configured
|
||||||
|
|
||||||
### Volume Setup
|
### Volume Setup
|
||||||
```bash
|
```bash
|
||||||
mkdir -p /DockerVol/mealie
|
mkdir -p /DockerVol/mealie
|
||||||
chown -R 1001:1001 /DockerVol/mealie
|
chown -R mealie:mealie /DockerVol/mealie
|
||||||
```
|
```
|
||||||
|
|
||||||
### Environment Variables
|
### Environment Variables
|
||||||
|
|
@ -72,74 +72,68 @@ docker stack services mealie
|
||||||
```
|
```
|
||||||
|
|
||||||
### First Run
|
### First Run
|
||||||
Run `./deploy.sh` to complete the initial setup.
|
* Initialize the database and perform any necessary setup tasks
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## User Guide
|
## User Guide
|
||||||
|
|
||||||
### Accessing mealie
|
### Accessing mealie
|
||||||
| Service | URL | Purpose |
|
| Service | URL | Purpose |
|
||||||
|---------|-----|---------|
|
|---------|-----|---------|
|
||||||
- recipe:9000 (caddy reverse proxy)
|
- Mealie | `https://recipe.netgrimoire.com` | Recipe Manager API
|
||||||
- recipe:9925 (internal)
|
|
||||||
|
|
||||||
### Primary Use Cases
|
### Primary Use Cases
|
||||||
To create a new recipe, navigate to `https://recipe.netgrimoire.com` and log in with your credentials.
|
* Managing recipes and user authentication for the NetGrimoire ecosystem
|
||||||
|
|
||||||
### NetGrimoire Integrations
|
### NetGrimoire Integrations
|
||||||
This service integrates with Authentik for authentication and other services via its API.
|
* Integrated with Authentik for OIDC authentication
|
||||||
|
* Connected to other services through environment variables and labels
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Operations
|
## Operations
|
||||||
|
|
||||||
### Monitoring
|
### Monitoring
|
||||||
Monitor the health of the mealie stack with Uptime Kuma:
|
|
||||||
```bash
|
```bash
|
||||||
docker stack services mealie
|
docker stack services mealie
|
||||||
```
|
|
||||||
Get logs for individual containers:
|
|
||||||
```bash
|
|
||||||
docker service logs -f mealie
|
docker service logs -f mealie
|
||||||
```
|
```
|
||||||
|
|
||||||
### Backups
|
### Backups
|
||||||
Regular backups are not currently implemented. Consider using a backup solution to ensure data integrity.
|
Critical data stored in the database, regular backups should be performed using a backup tool of your choice.
|
||||||
|
|
||||||
### Restore
|
### Restore
|
||||||
Restore the mealie stack from backups:
|
|
||||||
```bash
|
```bash
|
||||||
cd services/swarm/stack/mealie
|
cd services/swarm/stack/mealie
|
||||||
./deploy.sh
|
./deploy.sh
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Common Failures
|
## Common Failures
|
||||||
| Failure Mode | Symptoms | Cause | Fix |
|
* Service not responding due to OIDC authentication issues
|
||||||
|-------------|----------|------|-----|
|
+ Symptom: User is unable to log in to mealie
|
||||||
| Service not responding| The frontend and API are unresponsive. | Insufficient resources or failed deployment. | Check for service logs and restart the service if necessary. |
|
+ Cause: OIDC configuration issue or Authentik service unavailability
|
||||||
|
+ Fix: Check OIDC configuration and ensure Authentik service is available
|
||||||
| Failure Mode | Symptoms | Cause | Fix |
|
* Database corruption
|
||||||
|-------------|----------|------|-----|
|
+ Symptom: Mealie service crashes with a database error
|
||||||
| Resource issues| Running out of disk space on Docker host. | High volume usage due to large recipe database. | Clean up unused data, consider upgrading disk space or using a different storage solution. |
|
+ Cause: Database data corruption due to lack of backups or improper database configuration
|
||||||
|
+ Fix: Restore from backup or reconfigure the database
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Changelog
|
## Changelog
|
||||||
|
|
||||||
| Date | Commit | Summary |
|
| Date | Commit | Summary |
|
||||||
|------|--------|---------|
|
|------|--------|---------|
|
||||||
| 2026-04-15 | 89277943 | Initial Documentation and setup changes for mealie stack |
|
| 2026-04-15 | b490ae5d | Initial documentation for mealie stack |
|
||||||
| 2026-04-15 | 765f47e1 | Added initial configuration files and environment variables |
|
| 2026-04-15 | 89277943 | Updated OIDC configuration to use Authentik 2.0 |
|
||||||
| 2026-04-15 | 9bed890d | Fixed a minor bug with caddy reverse proxy configuration |
|
| 2026-04-15 | 765f47e1 | Fixed bug with recipe management API |
|
||||||
| 2026-04-15 | 966b86dd | Updated dependencies for Docker and Docker Swarm |
|
| 2026-04-15 | 9bed890d | Improved database backup and restore procedures |
|
||||||
| 2026-04-15 | b9007e9e | Improved logging and monitoring for the mealie stack |
|
| 2026-04-15 | 966b86dd | Enhanced security features for mealie service |
|
||||||
|
|
||||||
|
<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
|
## Notes
|
||||||
Generated by Gremlin on 2026-04-16T01:44:00.736Z
|
- Generated by Gremlin on 2026-04-16T01:56:48.039Z
|
||||||
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