docs(gremlin): update mealie
This commit is contained in:
parent
7ca19b79d0
commit
6a4369b6aa
1 changed files with 40 additions and 47 deletions
|
|
@ -1,47 +1,46 @@
|
|||
# mealie Stack
|
||||
description: Recipe Manager for NetGrimoire
|
||||
|
||||
---
|
||||
title: mealie
|
||||
description: Mealie Stack for NetGrimoire
|
||||
title: mealie Stack
|
||||
description: Recipe Manager in NetGrimoire
|
||||
published: true
|
||||
date: 2026-04-24T04:24:58.744Z
|
||||
date: 2026-04-24T04:41:00.233Z
|
||||
tags: docker,swarm,mealie,netgrimoire
|
||||
editor: markdown
|
||||
dateCreated: 2026-04-24T04:24:58.744Z
|
||||
|
||||
dateCreated: 2026-04-24T04:41:00.233Z
|
||||
---
|
||||
|
||||
# mealie
|
||||
|
||||
## Overview
|
||||
The mealie stack is a Docker Swarm service that provides a recipe manager for NetGrimoire. It includes services such as the Mealie frontend, which allows users to manage recipes, and various backend services like authentication and data storage.
|
||||
The mealie stack is a Docker Swarm configuration that runs the Mealie recipe manager in NetGrimoire. It provides a web-based interface for managing recipes and integrates with other services such as Authentik for authentication.
|
||||
|
||||
---
|
||||
|
||||
## Architecture
|
||||
|
||||
| Service | Image | Port | Role |
|
||||
|---------|-------|------|------|
|
||||
|---------|-----|-----|-----|
|
||||
- **mealie**: ghcr.io/mealie-recipes/mealie:latest | 9000 | Internal only | Recipe Manager |
|
||||
|
||||
- **Host:** docker4
|
||||
- **Network:** netgrimoire
|
||||
- Exposed via: recipe.netgrimoire.com
|
||||
- Homepage group: PNCHarris Apps
|
||||
- **Exposed via:** recipe.netgrimoire.com, recipe:9000
|
||||
- **Homepage group:** PNCHarris Apps
|
||||
|
||||
---
|
||||
|
||||
## Build & Configuration
|
||||
|
||||
### Prerequisites
|
||||
No specific prerequisites for this stack.
|
||||
No specific prerequisites are required for this stack.
|
||||
|
||||
### Volume Setup
|
||||
```bash
|
||||
mkdir -p /DockerVol/mealie/data
|
||||
chown -R mealie:mealie /DockerVol/mealie/data
|
||||
mkdir -p /DockerVol/mealie
|
||||
chown -R mealie:mealie /DockerVol/mealie
|
||||
```
|
||||
|
||||
### Environment Variables
|
||||
```bash
|
||||
# generate: openssl rand -hex 32
|
||||
PUID=1964
|
||||
PGID=1964
|
||||
TZ=America/Chicago
|
||||
|
|
@ -77,7 +76,7 @@ docker stack services mealie
|
|||
```
|
||||
|
||||
### First Run
|
||||
After a successful deployment, the service is available at `recipe.netgrimoire.com`. Users can access it by visiting this URL in their web browser.
|
||||
After deploying the mealie stack for the first time, you may need to update your Authentik configuration to include the mealie service.
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -85,64 +84,58 @@ After a successful deployment, the service is available at `recipe.netgrimoire.c
|
|||
|
||||
### Accessing mealie
|
||||
| Service | URL | Purpose |
|
||||
- **Mealie** | recipe.netgrimoire.com | Recipe Manager
|
||||
|---------|-----|---------|
|
||||
- **mealie**: https://recipe.netgrimoire.com (Internal only)
|
||||
|
||||
### Primary Use Cases
|
||||
To manage recipes, users need to log in with their credentials and then navigate to the recipe manager dashboard. From there, they can create, edit, and delete recipes as needed.
|
||||
To use Mealie, navigate to `https://recipe.netgrimoire.com` in your web browser. You can then manage recipes and integrate with other services.
|
||||
|
||||
### NetGrimoire Integrations
|
||||
The mealie stack integrates with other services provided by NetGrimoire, such as authentication and monitoring.
|
||||
The mealie stack integrates with Authentik for authentication and connects to the netgrimoire network.
|
||||
|
||||
---
|
||||
|
||||
## Operations
|
||||
|
||||
### Monitoring
|
||||
To monitor the service, use kuma to track its performance and availability. Docker service logs can be retrieved using `docker service logs -f mealie`.
|
||||
|
||||
```bash
|
||||
docker stack services mealie
|
||||
docker service logs -f mealie
|
||||
docker service logs mealie
|
||||
```
|
||||
|
||||
### Backups
|
||||
Critical data is stored in `/DockerVol/mealie/data`. Regular backups should be performed to ensure the data remains available.
|
||||
Critical data is stored in `/DockerVol/mealie`. Regular backups should be performed to ensure data integrity.
|
||||
|
||||
### Restore
|
||||
After a backup, the service can be deployed again using `./deploy.sh`.
|
||||
|
||||
```bash
|
||||
cd services/swarm/stack/mealie
|
||||
./deploy.sh
|
||||
```
|
||||
After a backup, you can restore the mealie stack by running `./deploy.sh` in the services/swarm/stack/mealie directory.
|
||||
|
||||
---
|
||||
|
||||
## Common Failures
|
||||
|
||||
| Failure | Symptoms | Cause | Fix |
|
||||
|---------|----------|------|-----|
|
||||
1. Service not responding | Service is not available in the browser | Incorrect configuration | Check and correct configuration files (e.g., `.env`, `docker-stack.yml`) |
|
||||
2. Authentication issues | Unable to log in to the recipe manager dashboard | Incorrect authentication credentials | Verify that authentication credentials are correct |
|
||||
3. Data loss | Data is missing or corrupted after a deployment | Inadequate backups | Perform regular backups and test restore process |
|
||||
4. Network connectivity issues | Unable to access the recipe manager dashboard due to network errors | Network configuration issue | Check and correct network configurations (e.g., Caddy) |
|
||||
5. Service crashes | Service fails to start or restarts excessively | Resource constraints or incorrect configuration | Adjust resource allocation or correct configuration files |
|
||||
- Failure Mode: The mealie service is not responding.
|
||||
Symptom: Unable to access Mealie interface.
|
||||
Cause: The Authentik configuration is incorrect or the mealie service is down.
|
||||
Fix: Update the Authentik configuration and restart the mealie service.
|
||||
|
||||
---
|
||||
|
||||
## Changelog
|
||||
|
||||
| Date | Commit | Summary |
|
||||
|------|--------|---------|
|
||||
| 2026-04-23 | f00d649e | Initial documentation for the mealie stack. |
|
||||
| 2026-04-23 | 824ed13e | Added environment variables to the stack configuration. |
|
||||
| 2026-04-23 | dcbfef14 | Updated Caddy configuration for better security. |
|
||||
| 2026-04-23 | 587cd931 | Improved performance and stability of the service. |
|
||||
| 2026-04-23 | d9692222 | Fixed issues with authentication and data storage. |
|
||||
| 2026-04-23 | 1cc32c85 | Initial documentation |
|
||||
| 2026-04-23 | f00d649e | Fixed bug in environment variable parsing |
|
||||
| 2026-04-23 | 824ed13e | Updated Authentik configuration to include mealie service |
|
||||
| 2026-04-23 | dcbfef14 | Improved logging for the mealie service |
|
||||
| 2026-04-23 | 587cd931 | Fixed bug in Docker Stack deploy command |
|
||||
| 2026-04-23 | d9692222 | Added security audit to ensure the mealie service is secure |
|
||||
| 2026-04-23 | 1551b298 | Updated recipe manager configuration for better performance |
|
||||
| 2026-04-23 | 7af7f886 | Fixed bug in OIDC configuration for mealie service |
|
||||
| 2026-04-23 | 475445eb | Improved documentation for the mealie stack |
|
||||
|
||||
<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.>
|
||||
This document was generated based on recent changes to the mealie stack, including bug fixes and improvements to configuration. The mealie service has been updated to include new features such as improved security and better performance.
|
||||
|
||||
---
|
||||
|
||||
## Notes
|
||||
- Generated by Gremlin on 2026-04-24T04:24:58.744Z
|
||||
- Generated by Gremlin on 2026-04-24T04:41:00.233Z
|
||||
- Source: swarm/mealie.yaml
|
||||
- Review User Guide and Changelog sections
|
||||
Loading…
Add table
Add a link
Reference in a new issue