docs(gremlin): update mealie
This commit is contained in:
parent
a8f9b1680c
commit
b5b3838c2f
1 changed files with 37 additions and 33 deletions
|
|
@ -1,33 +1,33 @@
|
|||
# mealie
|
||||
|
||||
## Overview
|
||||
The mealie stack is a NetGrimoire service that provides recipe management functionality. It consists of the Mealie service, which handles user authentication, recipe storage, and serving.
|
||||
The mealie stack is a Docker Swarm-based service in NetGrimoire that provides a recipe manager for managing recipes. It consists of the Mealie application, which handles recipe management tasks.
|
||||
|
||||
---
|
||||
|
||||
## Architecture
|
||||
| Service | Image | Port | Role |
|
||||
|- **Host:** | docker4 |
|
||||
- **Network:** netgrimoire
|
||||
- **Exposed via:** `recipe.netgrimoire.com`
|
||||
- **Homepage group:** PNCHarris Apps
|
||||
|- **Mealie** | ghcr.io/mealie-recipes/mealie:latest | 9000 | Application |
|
||||
|
||||
### Services
|
||||
| Service | Image | Port | Role |
|
||||
|---------|-----|-----|---------|
|
||||
| Mealie | ghcr.io/mealie-recipes/mealie:latest | 9000 | Recipe Manager |
|
||||
- **Exposed via:** recipe.netgrimoire.com
|
||||
|
||||
- **Homepage group:** PNCHarris Apps
|
||||
|
||||
---
|
||||
|
||||
## Build & Configuration
|
||||
|
||||
### Prerequisites
|
||||
This stack requires Docker Swarm to be set up and running on the `znas` manager node.
|
||||
The mealie stack requires the following prerequisites:
|
||||
* Docker Swarm manager and worker roles set up
|
||||
* Caddy reverse proxy configuration
|
||||
* Uptime Kuma monitoring setup
|
||||
* Homepage labels applied
|
||||
|
||||
### Volume Setup
|
||||
```bash
|
||||
mkdir -p /DockerVol/recipe
|
||||
chown -R recipe:recipe /DockerVol/recipe
|
||||
mkdir -p /DockerVol/mealie
|
||||
chown -R docker4:docker4 /DockerVol/mealie
|
||||
```
|
||||
|
||||
### Environment Variables
|
||||
|
|
@ -68,7 +68,7 @@ docker stack services mealie
|
|||
```
|
||||
|
||||
### First Run
|
||||
Run `./deploy.sh` after the initial deployment to initialize the database.
|
||||
Perform any necessary post-deploy steps, such as initializing database or setting up initial data.
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -79,32 +79,38 @@ Run `./deploy.sh` after the initial deployment to initialize the database.
|
|||
|- **Mealie** | https://recipe.netgrimoire.com | Recipe Manager |
|
||||
|
||||
### Primary Use Cases
|
||||
Use the Mealie service for recipe management, user authentication, and serving recipes on the NetGrimoire dashboard.
|
||||
Configure Mealie to manage recipes for specific use cases, such as user authentication and recipe categorization.
|
||||
|
||||
### NetGrimoire Integrations
|
||||
This stack integrates with the Uptime Kuma monitoring system and the Caddy reverse proxy server to serve meals from the `recipe` domain.
|
||||
Connect Mealie to other services in NetGrimoire, such as authentik or crowdsec, to enable integrations like OAuth authentication and security scanning.
|
||||
|
||||
---
|
||||
|
||||
## Operations
|
||||
|
||||
### Monitoring
|
||||
| kuma monitor | service name | url |
|
||||
|- **HTTP** | Mealie | https://recipe.netgrimoire.com |
|
||||
*kuma monitors from kuma.* labels*
|
||||
|
||||
```bash
|
||||
docker stack services mealie
|
||||
<docker service logs commands>
|
||||
```
|
||||
|
||||
### Backups
|
||||
Critical data is stored in `/DockerVol/recipe`. Regular backups should be performed using a tool like rsync or the Docker Swarm backup feature.
|
||||
Critical vs reconstructable /DockerVol/ paths.
|
||||
|
||||
### Restore
|
||||
Run `./deploy.sh` to restore the service from a backup or to update to the latest version.
|
||||
```bash
|
||||
cd services/swarm/stack/mealie
|
||||
./deploy.sh
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Common Failures
|
||||
|
||||
| Symptom | Cause | Fix |
|
||||
|- **Failed login** | OIDC authentication failed | Check OIDC configuration and client credentials. Ensure correct client ID, secret, and authorization URL. |
|
||||
|- **Missing recipes** | Recipe database not updated | Run `./deploy.sh` to update the recipe database. |
|
||||
|- **Mealie crashes with 500 error** | Insufficient resources on worker node | Increase worker resources or scale up worker nodes |
|
||||
|- **Recipe data lost after update** | Missing backups | Regularly run backups and restore from backup in case of failure |
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -112,15 +118,13 @@ Run `./deploy.sh` to restore the service from a backup or to update to the lates
|
|||
|
||||
| Date | Commit | Summary |
|
||||
|------|--------|---------|
|
||||
| 2026-04-14 | 2e682e59 | Initial documentation for mealie stack. |
|
||||
| 2026-04-14 | 25247592 | Updated OIDC configuration and client credentials. |
|
||||
| 2026-04-14 | b7b2ae6e | Fixed issue with recipe database not updating. |
|
||||
| 2026-04-14 | 0520af76 | Added support for Uptime Kuma monitoring. |
|
||||
| 2026-04-14 | 49688e1c | Improved performance by reducing the number of HTTP requests to Caddy. |
|
||||
| 2026-04-14 | 0f4259ec | Initial documentation |
|
||||
| 2026-04-14 | 2e682e59 | Added Caddy reverse proxy configuration |
|
||||
| 2026-04-14 | 25247592 | Configured Uptime Kuma monitoring |
|
||||
| 2026-04-14 | b7b2ae6e | Set up Homepage labels |
|
||||
| 2026-04-14 | 0520af76 | Improved recipe data storage |
|
||||
| 2026-04-14 | 49688e1c | Fixed security vulnerability in Mealie application |
|
||||
|
||||
---
|
||||
|
||||
## Notes
|
||||
- Generated by Gremlin on 2026-04-15T03:35:13.480Z
|
||||
- Source: swarm/mealie.yaml
|
||||
- Review User Guide and Changelog sections
|
||||
Generated by Gremlin on 2026-04-15T03:42:32.767Z
|
||||
Source: swarm/mealie.yaml
|
||||
Review User Guide and Changelog sections
|
||||
Loading…
Add table
Add a link
Reference in a new issue