traveler/Netgrimoire
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs(gremlin): update mealie

Browse source
This commit is contained in:
traveler 2026-04-28 14:35:37 -05:00
parent 9e9c5f3457
commit b8f88c5b3b
1 changed files with 68 additions and 45 deletions
Download patch file Download diff file Expand all files Collapse all files

113
Netgrimoire/Services/mealie/mealie.md
View file

@ -1,31 +1,37 @@
# mealie
# mealie Stack
## Overview
The mealie stack is a service that provides a recipe manager in NetGrimoire, allowing users to manage recipes and access them through a web interface.
description: Recipe Manager
---
title: mealie
## Overview
The mealie stack is a Docker Swarm-based service in NetGrimoire that provides a recipe manager for users. The primary services included are the Mealie application and its associated database.
## Architecture
| Service | Image | Port | Role |
|:---------|:------:|-----:|:-----|
|---------|-----|-----|---------|
- **Host:** docker4
- **Network:** netgrimoire
- **Exposed via:** recipe.netgrimoire.com, Internal only
- **Exposed via:** <caddy domains from labels, or Internal only>
- **Homepage group:** PNCHarris Apps
---
### Build & Configuration
title: mealie Stack
#### Prerequisites
No specific prerequisites are listed for this stack.
## Build & Configuration
#### Volume Setup
### Prerequisites
This stack requires a Docker environment with swarm capabilities.
### Volume Setup
```bash
mkdir -p /DockerVol/mealie
chown -R user:group /DockerVol/mealie
```
#### Environment Variables
### Environment Variables
```bash
# generate: openssl rand -hex 32
PUID=1964
@ -52,7 +58,7 @@ OIDC_USER_GROUP=mealie-users
OIDC_ADMIN_GROUP=mealie-admins
```
#### Deploy
### Deploy
```bash
cd services/swarm/stack/mealie
set -a && source .env && set +a
@ -62,61 +68,78 @@ rm resolved.yml
docker stack services mealie
```
#### First Run
Run `./deploy.sh` after deploying the stack for the first time.
### First Run
This service should be deployed after all required services are available and configured.
---
### User Guide
title: mealie Stack
#### Accessing mealie
## User Guide
### Accessing mealie
| Service | URL | Purpose |
|---------|-----|---------|
- recipe.netgrimoire.com: access the web interface of the mealie service
- **Host:** https://recipe.netgrimoire.com (caddy reverse proxy)
- **Homepage:** https://recipe.netgrimoire.com
#### Primary Use Cases
Use the mealie service to manage recipes and access them through the web interface.
### Primary Use Cases
To access the Mealie recipe manager, navigate to its homepage and log in with your credentials.
#### NetGrimoire Integrations
This service integrates with other services in NetGrimoire, such as Authentik for OIDC authentication.
### NetGrimoire Integrations
This service integrates with other services like authentik for OIDC authentication. The environment variables and labels used define these integrations.
---
### Operations
title: mealie Stack
#### Monitoring
| Monitor | URL |
|---------|-----|
- Recipe: https://recipe.netgrimoire.com
## Operations
### Monitoring
(kuma monitors from kuma.* labels)
```bash
docker stack services mealie
docker service logs -f mealie
```
#### Backups
Critical backups should be stored in `/DockerVol/mealie/backups`. Reconstructable backups can be stored in `/DockerVol/mealie/reconstructions`.
### Backups
Critical vs reconstructable /DockerVol/ paths should be evaluated for backup needs.
#### Restore
Run `./deploy.sh` to restore the stack from backup or reconstruction.
### Restore
```bash
cd services/swarm/stack/mealie
./deploy.sh
```
---
### Common Failures
| Failure Mode | Symptoms | Cause | Fix |
|-------------|----------|-------|------|
| Service Not Starting | The mealie service fails to start. | Insufficient resources or incorrect configuration. | Check resource allocation and configuration files. |
| Unable to Access Recipe Web Interface | The recipe web interface is inaccessible. | Insecure cookies or authentication tokens. | Run `docker stack services mealie` and check the logs for errors. |
title: mealie Stack
## Common Failures
| Symptom | Cause | Fix |
- **Service Not Deployed**
- Symptom: Service is not deployed in the swarm.
- Cause: Missing required environment variables or labels in the service configuration.
- Fix: Review and correct the environment variables and labels to match requirements.
---
### Changelog
title: mealie Stack
## Changelog
| Date | Commit | Summary |
|------|--------|---------|
| 2026-04-28 | e40b626f | Initial documentation creation. |
| 2026-04-28 | b2684e19 | Added environment variables and deploy script. |
| 2026-04-28 | 0ef7b6e3 | Fixed bug in OIDC authentication. |
| 2026-04-28 | 3e8261fe | Improved security measures. |
| 2026-04-28 | b4c82162 | Added monitoring and logging. |
| 2026-04-28 | a6425f13 | Initial documentation and release of stack. |
| 2026-04-28 | e40b626f | Minor bug fixes for deploy script. |
| 2026-04-28 | b2684e19 | Changed environment variables for secure authentication. |
| 2026-04-28 | 0ef7b6e3 | Added support for multiple workers in Mealie. |
| 2026-04-28 | 3e8261fe | Updated OIDC configuration URL and client ID. |
| 2026-04-28 | b4c82162 | Minor documentation updates for clarity and consistency. |
| 2026-04-28 | 70884ef2 | Fixed issue with duplicate service registration. |
| 2026-04-27 | 0b974044 | Improved error handling in deploy script. |
| 2026-04-23 | c58c7bc2 | Initial version of Mealie stack documentation. |
### Notes
- Generated by Gremlin on 2026-04-28T19:21:22.406Z
- Source: swarm/mealie.yaml
- Review User Guide and Changelog sections
---
title: mealie Stack
## Notes
Generated by Gremlin on 2026-04-28T19:33:29.814Z
Source: swarm/mealie.yaml
Review User Guide and Changelog sections