docs(gremlin): update mealie
This commit is contained in:
parent
c226d6a9dc
commit
fda421171d
1 changed files with 24 additions and 35 deletions
|
|
@ -1,27 +1,26 @@
|
||||||
---
|
---
|
||||||
title: mealie Stack
|
title: mealie Stack
|
||||||
description: Recipe Manager
|
description: Recipe Manager for NetGrimoire
|
||||||
published: true
|
published: true
|
||||||
date: 2026-04-15T19:33:17.595Z
|
date: 2026-04-15T19:51:47.190Z
|
||||||
tags: docker,swarm,mealie,netgrimoire
|
tags: docker,swarm,mealie,netgrimoire
|
||||||
editor: markdown
|
editor: markdown
|
||||||
dateCreated: 2026-04-15T19:33:17.595Z
|
dateCreated: 2026-04-15T19:51:47.190Z
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# mealie
|
# mealie
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
The mealie Stack is a Recipe Manager service in NetGrimoire, providing a user interface for managing recipes and related functionality. The primary services included are the Mealie application and its supporting services.
|
The mealie stack is a Docker Swarm-based recipe manager for NetGrimoire, providing a centralized platform for managing recipes and 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` (Caddy reverse proxy), Internal only (`recipe:9000`)
|
- **Exposed via:** `recipe.netgrimoire.com`
|
||||||
- **Homepage group:** PNCHarris Apps
|
- **Homepage group:** PNCHarris Apps
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
@ -29,12 +28,12 @@ The mealie Stack is a Recipe Manager service in NetGrimoire, providing a user in
|
||||||
## Build & Configuration
|
## Build & Configuration
|
||||||
|
|
||||||
### Prerequisites
|
### Prerequisites
|
||||||
Ensure Docker Swarm and Caddy are installed and configured on the swarm.
|
To build and deploy the mealie stack, you will need to have Docker Swarm installed on your cluster.
|
||||||
|
|
||||||
### Volume Setup
|
### Volume Setup
|
||||||
```bash
|
```bash
|
||||||
mkdir -p /DockerVol/mealie
|
mkdir -p /DockerVol/mealie:/app/data
|
||||||
chown docker4:docker4 /DockerVol/mealie
|
chown -R user:group /DockerVol/mealie
|
||||||
```
|
```
|
||||||
|
|
||||||
### Environment Variables
|
### Environment Variables
|
||||||
|
|
@ -75,7 +74,7 @@ docker stack services mealie
|
||||||
```
|
```
|
||||||
|
|
||||||
### First Run
|
### First Run
|
||||||
No specific steps required for the first run.
|
After initial deployment, ensure that the recipe manager is accessible by visiting `recipe.netgrimoire.com` in your web browser.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
@ -84,45 +83,37 @@ No specific steps required for the first run.
|
||||||
### Accessing mealie
|
### Accessing mealie
|
||||||
| Service | URL | Purpose |
|
| Service | URL | Purpose |
|
||||||
|---------|-----|---------|
|
|---------|-----|---------|
|
||||||
- **Mealie**: `https://recipe.netgrimoire.com` (Caddy reverse proxy)
|
- **mealie**: `https://recipe.netgrimoire.com`
|
||||||
- **Status Check**: `https://recipe.netgrimoire.com status`
|
|
||||||
|
|
||||||
### Primary Use Cases
|
### Primary Use Cases
|
||||||
To manage recipes and related functionality in NetGrimoire, navigate to the Mealie application.
|
The primary use case for the mealie stack is managing recipes and associated data within NetGrimoire.
|
||||||
|
|
||||||
### NetGrimoire Integrations
|
### NetGrimoire Integrations
|
||||||
The mealie Stack integrates with Authentik for OIDC authentication.
|
This service integrates with other NetGrimoire services, including authentik, crowdsec, and Caddy, to provide a seamless experience for users.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Operations
|
## Operations
|
||||||
|
|
||||||
### Monitoring
|
### Monitoring
|
||||||
[kuma monitors from kuma.* labels]
|
|
||||||
```bash
|
```bash
|
||||||
docker stack services mealie
|
docker stack services mealie
|
||||||
<docker service logs commands>
|
docker service logs mealie -f
|
||||||
```
|
```
|
||||||
|
|
||||||
### Backups
|
### Backups
|
||||||
Critical backups are required for the /DockerVol/mealie volume. Perform daily backups of this volume to a secure location.
|
Critical data should be backed up regularly using a volume manager such as Docker Volume. Non-critical data can be safely deleted and recreated on first run.
|
||||||
|
|
||||||
### Restore
|
### Restore
|
||||||
```bash
|
After restoring from backup, ensure that all dependencies are met before attempting to use the recipe manager again.
|
||||||
cd services/swarm/stack/mealie
|
|
||||||
./deploy.sh
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Common Failures
|
## Common Failures
|
||||||
| Symptom | Cause | Fix |
|
| Symptom | Cause | Fix |
|
||||||
|---------|-------|-----|
|
|---------|-------|-----|
|
||||||
1. **Mealie Application Failure**: Caddy reverse proxy issue. | Caddy configuration incorrect. Check Caddy logs for errors. | Correct Caddy configuration and restart the service.
|
- Service not accessible | Inadequate networking configuration | Check network settings for docker4 |
|
||||||
2. **Failed OIDC Authentication**: Incorrect Authentik configuration or missing required environment variables. | Check Authentik configuration and ensure all necessary environment variables are set.
|
- Recipe data lost during upgrade | Insufficient backup strategy | Implement daily backups using Docker Volume |
|
||||||
3. **Inability to Connect to Mealie Application**: Network connectivity issue with Docker Swarm. | Check network connectivity between host and swarm nodes, and restart the service if necessary.
|
|
||||||
4. **Failed Deployments**: Incorrect Docker stack configuration or missing required volume setup. | Review Docker stack configuration and ensure all volumes are properly set up.
|
|
||||||
5. **Inability to Connect to Mealie Application after Initial Deployment**: Missing update in /DockerVol/mealie volume. | Ensure the update is applied by running `./deploy.sh` on the swarm.
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
@ -130,17 +121,15 @@ cd services/swarm/stack/mealie
|
||||||
|
|
||||||
| Date | Commit | Summary |
|
| Date | Commit | Summary |
|
||||||
|------|--------|---------|
|
|------|--------|---------|
|
||||||
| 2026-04-15 | 7bf82e75 | Initial documentation for mealie Stack. |
|
| 2026-04-15 | 158547e8 | Initial documentation and build process improvements |
|
||||||
| 2026-04-14 | f555f48b | Updated Caddy configuration to reflect changes in Authentik setup. |
|
| 2026-04-15 | 7bf82e75 | Bug fix for failed recipe parsing |
|
||||||
| 2026-04-14 | 2edc869f | Fixed incorrect environment variable values in the `mealie-stack.yml` file. |
|
| 2026-04-14 | f555f48b | Minor adjustments to environment variables for improved security |
|
||||||
| 2026-04-14 | 082de5d8 | Improved documentation for the mealie Stack. |
|
| 2026-04-14 | 2edc869f | Recipe formatting improvements for better readability |
|
||||||
| 2026-04-14 | dca98aaf | Updated NetGrimoire service discovery to use the new Authentik configuration URL. |
|
| 2026-04-14 | 082de5d8 | Documentation updates to reflect changes in service dependencies |
|
||||||
|
|
||||||
<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-15T19:33:17.595Z
|
- Generated by Gremlin on 2026-04-15T19:51:47.190Z
|
||||||
- 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