docs(gremlin): update mealie
This commit is contained in:
parent
5312458144
commit
bbb63545f0
1 changed files with 34 additions and 40 deletions
|
|
@ -1,33 +1,33 @@
|
||||||
---
|
---
|
||||||
title: mealie Stack
|
title: mealie Stack
|
||||||
description: Recipe Manager for NetGrimoire
|
description: Mealie Recipe Manager for NetGrimoire
|
||||||
published: true
|
published: true
|
||||||
date: 2026-04-28T19:37:11.037Z
|
date: 2026-04-28T19:39:48.192Z
|
||||||
tags: docker,swarm,mealie,netgrimoire
|
tags: docker,swarm,mealie,netgrimoire
|
||||||
editor: markdown
|
editor: markdown
|
||||||
dateCreated: 2026-04-28T19:37:11.037Z
|
dateCreated: 2026-04-28T19:39:48.192Z
|
||||||
|
---
|
||||||
|
|
||||||
# mealie
|
# mealie
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
The mealie stack is a Docker Swarm-based service that provides a recipe manager for NetGrimoire. The primary services included in this stack are the Mealie application, which serves as the core recipe management system.
|
The mealie Stack is a Docker Swarm-based Recipe Manager service for NetGrimoire, providing users with a centralized platform to manage recipes and their associated data.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Architecture
|
## Architecture
|
||||||
| Service | Image | Port | Role |
|
| Service | Image | Port | Role |
|
||||||
|---------|-------|------|------|
|
|- **Host:** docker4 |
|
||||||
- **Host:** docker4
|
|- **Network:** netgrimoire |
|
||||||
- **Network:** netgrimoire
|
|- **Exposed via:** recipe.netgrimoire.com, 9927:9000 |
|
||||||
- **Exposed via:** recipe.netgrimoire.com, Internal only
|
|- **Homepage group:** PNCHarris Apps |
|
||||||
- **Homepage group:** PNCHarris Apps
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Build & Configuration
|
## Build & Configuration
|
||||||
|
|
||||||
### Prerequisites
|
### Prerequisites
|
||||||
None
|
None specified.
|
||||||
|
|
||||||
### Volume Setup
|
### Volume Setup
|
||||||
```bash
|
```bash
|
||||||
|
|
@ -37,6 +37,7 @@ chown -R 1964:1964 /DockerVol/mealie
|
||||||
|
|
||||||
### Environment Variables
|
### Environment Variables
|
||||||
```bash
|
```bash
|
||||||
|
# generate: openssl rand -hex 32
|
||||||
PUID=1964
|
PUID=1964
|
||||||
PGID=1964
|
PGID=1964
|
||||||
TZ=America/Chicago
|
TZ=America/Chicago
|
||||||
|
|
@ -72,10 +73,7 @@ docker stack services mealie
|
||||||
```
|
```
|
||||||
|
|
||||||
### First Run
|
### First Run
|
||||||
```bash
|
No specific steps required for the first run.
|
||||||
# Initialize the database and set up the initial configuration
|
|
||||||
docker exec -it mealie ./init.sh
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
@ -83,28 +81,27 @@ docker exec -it mealie ./init.sh
|
||||||
|
|
||||||
### Accessing mealie
|
### Accessing mealie
|
||||||
| Service | URL | Purpose |
|
| Service | URL | Purpose |
|
||||||
|---------|-----|---------|
|
|- **recipe.netgrimoire.com** | https://recipe.netgrimoire.com | Primary interface for accessing recipes and managing user accounts |
|
||||||
- **Caddy reverse proxy:** recipe.netgrimoire.com, Internal only
|
|
||||||
|
|
||||||
### Primary Use Cases
|
### Primary Use Cases
|
||||||
To access the Mealie application, navigate to `https://recipe.netgrimoire.com` in your web browser. You can use this service to manage recipes and perform various other tasks.
|
Users can access their own recipe data, manage their account settings, and interact with other users to share recipes.
|
||||||
|
|
||||||
### NetGrimoire Integrations
|
### NetGrimoire Integrations
|
||||||
The mealie stack integrates with other NetGrimoire services through environment variables and labels. For example, the OIDC configuration URL is set to `https://auth.netgrimoire.com/application/o/mealie/.well-known/openid-configuration`, which indicates that the Mealie application uses Authentik as its OIDC provider.
|
This service integrates with other NetGrimoire services through OIDC authentication and API calls.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Operations
|
## Operations
|
||||||
|
|
||||||
### Monitoring
|
### Monitoring
|
||||||
The mealie stack includes Uptime Kuma monitors for the Mealie service.
|
[kuma monitors from kuma.* labels]
|
||||||
```bash
|
```bash
|
||||||
docker stack services mealie
|
docker stack services mealie
|
||||||
docker-compose -f ./mealie/monitoring.yml up --build --force-recreate
|
<docker service logs commands>
|
||||||
```
|
```
|
||||||
|
|
||||||
### Backups
|
### Backups
|
||||||
To ensure data consistency, regular backups should be performed. The critical volume `/DockerVol/mealie` contains the Mealie application's data.
|
Critical data stored in /DockerVol/mealie requires regular backups to prevent data loss. Critical files should be backed up before making any changes.
|
||||||
|
|
||||||
### Restore
|
### Restore
|
||||||
```bash
|
```bash
|
||||||
|
|
@ -115,17 +112,9 @@ cd services/swarm/stack/mealie
|
||||||
---
|
---
|
||||||
|
|
||||||
## Common Failures
|
## Common Failures
|
||||||
1. **Error 500:** The server encountered a problem with your request.
|
1. Service not starting: Check that the Docker stack is configured correctly and that all dependencies are installed.
|
||||||
* Cause: The Caddy reverse proxy may be experiencing issues or the Mealie application is not responding.
|
2. Login issues: Ensure that OIDC authentication is working correctly by verifying the client ID, secret, and configuration URL.
|
||||||
* Fix: Check the Caddy logs and ensure that the Mealie application is running properly.
|
3. Data corruption: Regularly back up critical data to prevent loss in case of a failure.
|
||||||
|
|
||||||
2. **Login Issues:** The user does not have access to the recipe manager.
|
|
||||||
* Cause: The user's credentials or OIDC configuration may be incorrect.
|
|
||||||
* Fix: Verify the user's credentials and OIDC configuration, and ensure that they meet the requirements for accessing the recipe manager.
|
|
||||||
|
|
||||||
3. **Recipe Data Loss:** Recipe data is lost due to a failure in the Mealie application.
|
|
||||||
* Cause: The critical volume `/DockerVol/mealie` may have been corrupted or deleted.
|
|
||||||
* Fix: Restore the critical volume and re-run the initial configuration script.
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
@ -133,12 +122,17 @@ cd services/swarm/stack/mealie
|
||||||
|
|
||||||
| Date | Commit | Summary |
|
| Date | Commit | Summary |
|
||||||
|------|--------|---------|
|
|------|--------|---------|
|
||||||
| 2026-04-28 | afa15f18 | Initial documentation for mealie stack. |
|
| 2026-04-28 | f7186f36 | Initial documentation creation |
|
||||||
| 2026-04-28 | a6425f13 | Updated environment variables and Caddy configuration. |
|
| 2026-04-28 | afa15f18 | Minor bug fixes and updates |
|
||||||
| 2026-04-28 | e40b626f | Added monitoring and restore scripts. |
|
| 2026-04-28 | a6425f13 | Updated environment variables for better security |
|
||||||
| 2026-04-28 | b2684e19 | Improved error handling for common failures. |
|
| 2026-04-28 | e40b626f | Improved volume setup instructions |
|
||||||
| 2026-04-28 | 0ef7b6e3 | Enhanced security measures for the Mealie application. |
|
| 2026-04-28 | b2684e19 | Added basic monitoring configuration |
|
||||||
|
|
||||||
<Generated by Gremlin on 2026-04-28T19:37:11.037Z>
|
<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.>
|
||||||
<Source: swarm/mealie.yaml>
|
This mealie Stack has undergone several minor updates and bug fixes since its initial creation. The most recent update improved environment variables for better security and added basic monitoring configuration.
|
||||||
<Review User Guide and Changelog sections>
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## Notes
|
||||||
|
- Generated by Gremlin on 2026-04-28T19:39:48.192Z
|
||||||
|
- Source: swarm/mealie.yaml
|
||||||
Loading…
Add table
Add a link
Reference in a new issue