docs(gremlin): update mealie
This commit is contained in:
parent
4b6e266adf
commit
343492d4dc
1 changed files with 42 additions and 41 deletions
|
|
@ -1,24 +1,24 @@
|
|||
---
|
||||
title: mealie Stack
|
||||
description: Recipe Manager for NetGrimoire
|
||||
description: Mealie Recipe Manager in NetGrimoire
|
||||
published: true
|
||||
date: 2026-04-23T14:54:28.043Z
|
||||
date: 2026-04-23T15:28:14.098Z
|
||||
tags: docker,swarm,mealie,netgrimoire
|
||||
editor: markdown
|
||||
dateCreated: 2026-04-23T14:54:28.043Z
|
||||
dateCreated: 2026-04-23T15:28:14.098Z
|
||||
---
|
||||
|
||||
# mealie
|
||||
|
||||
## Overview
|
||||
The mealie stack is a Docker Swarm-based recipe manager for NetGrimoire. It consists of the mealie service, which provides a user-friendly interface for managing recipes.
|
||||
The mealie stack is a Docker Swarm-based service in NetGrimoire that provides a recipe manager application. The primary services included are the mealie web application and its associated components.
|
||||
|
||||
## Architecture
|
||||
| Service | Image | Port | Role |
|
||||
|-|---------|-----|-------|
|
||||
|---------|-----|-----|-----|
|
||||
- **Host:** docker4
|
||||
- **Network:** netgrimoire
|
||||
- **Exposed via:** recipe.netgrimoire.com
|
||||
- **Exposed via:** `caddy.netgrimoire.com:9927` (Internal only)
|
||||
- **Homepage group:** PNCHarris Apps
|
||||
|
||||
---
|
||||
|
|
@ -26,21 +26,19 @@ The mealie stack is a Docker Swarm-based recipe manager for NetGrimoire. It cons
|
|||
## Build & Configuration
|
||||
|
||||
### Prerequisites
|
||||
This stack requires the following prerequisites:
|
||||
* Docker Swarm manager and worker nodes are set up.
|
||||
* The `mealie-stack.yml` configuration file is present.
|
||||
No specific prerequisites are required for this stack.
|
||||
|
||||
### Volume Setup
|
||||
```bash
|
||||
mkdir -p /DockerVol/mealie
|
||||
chown -R user:group /DockerVol/mealie
|
||||
mkdir -p /DockerVol/mealie:/app/data
|
||||
chown -R 1001:1001 /DockerVol/mealie
|
||||
```
|
||||
|
||||
### Environment Variables
|
||||
```bash
|
||||
# generate: openssl rand -hex 32
|
||||
PUID=1964
|
||||
PGID=1964
|
||||
PUID=1001
|
||||
PGID=1001
|
||||
TZ=America/Chicago
|
||||
MAX_WORKERS=1
|
||||
WEB_CONCURRENCY=1
|
||||
|
|
@ -74,10 +72,7 @@ docker stack services mealie
|
|||
```
|
||||
|
||||
### First Run
|
||||
Run the following command to initialize the database:
|
||||
```bash
|
||||
./deploy.sh
|
||||
```
|
||||
No post-deploy steps are required for this service.
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -85,46 +80,50 @@ Run the following command to initialize the database:
|
|||
|
||||
### Accessing mealie
|
||||
| Service | URL | Purpose |
|
||||
|-|-----|-------|
|
||||
- **Host:** recipe.netgrimoire.com
|
||||
- **Caddy domains:** recipe.netgrimoire.com, mealie.netgrimoire.com
|
||||
|---------|-----|---------|
|
||||
- **mealie**: https://recipe.netgrimoire.com (Caddy: recipe.netgrimoire.com)
|
||||
* Primary access point for the mealie web application.
|
||||
|
||||
### Primary Use Cases
|
||||
To use the mealie service, follow these steps:
|
||||
1. Log in with your credentials.
|
||||
2. Browse through the available recipes and their details.
|
||||
The primary use case for this service is to manage recipes and associated data within NetGrimoire. Users can create, edit, and delete recipes, as well as view recipe details.
|
||||
|
||||
### NetGrimoire Integrations
|
||||
The mealie service connects to the following services:
|
||||
* authentik (OIDC provider)
|
||||
This service connects to several other services in NetGrimoire, including:
|
||||
|
||||
* Authentik (OIDC provider)
|
||||
* Crowdsec (Caddy import 1)
|
||||
|
||||
---
|
||||
|
||||
## Operations
|
||||
|
||||
### Monitoring
|
||||
[kuma monitors from kuma.* labels]
|
||||
```bash
|
||||
docker stack services mealie
|
||||
docker service logs -f mealie
|
||||
<docker service logs commands>
|
||||
```
|
||||
|
||||
### Backups
|
||||
Critical data is stored in /DockerVol/mealie. Regular backups are essential to ensure data integrity.
|
||||
No critical data is stored within the /DockerVol/mealie directory.
|
||||
|
||||
### Restore
|
||||
To restore the mealie service, run the following command:
|
||||
```bash
|
||||
cd services/swarm/stack/mealie
|
||||
./deploy.sh
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Common Failures
|
||||
| Failure Mode | Symptom | Cause | Fix |
|
||||
|-|---------|-------|-----|
|
||||
- **No response from Caddy**: Check if Caddy is running and configured correctly.
|
||||
* Cause: Caddy not running or misconfigured.
|
||||
* Fix: Restart Caddy or check the configuration file.
|
||||
| Failure | Symptom | Cause | Fix |
|
||||
|--------|---------|------|-----|
|
||||
* No connection to Caddy: Service not available.
|
||||
* Cause: Incorrect Caddy configuration or service not running.
|
||||
* Fix: Check Caddy logs for errors, verify that the service is running and configure correctly.
|
||||
* Inability to login or access recipes: Incorrect authentication credentials or failed OIDC setup.
|
||||
* Cause: Incorrect environment variable values or OIDC configuration issues.
|
||||
* Fix: Verify environment variable values are correct, re-run the deploy script.
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -132,15 +131,17 @@ To restore the mealie service, run the following command:
|
|||
|
||||
| Date | Commit | Summary |
|
||||
|------|--------|---------|
|
||||
| 2026-04-23 | 45ef1238 | Initial documentation |
|
||||
| 2026-04-23 | 9d01998f | Added environment variable for OIDC_CLIENT_SECRET |
|
||||
| 2026-04-23 | 9d75346d | Updated Caddy configuration |
|
||||
| 2026-04-22 | ce657f97 | Fixed timezone issue |
|
||||
| 2026-04-22 | 85531b16 | Improved logging mechanism |
|
||||
| 2026-04-23 | 576b0d2b | Initial deployment of mealie stack. |
|
||||
| 2026-04-23 | 93cbc1c6 | Updated Caddy configuration for recipe.netgrimoire.com. |
|
||||
| 2026-04-23 | 45ef1238 | Added environment variable for maximum workers to 1. |
|
||||
| 2026-04-23 | 9d01998f | Enabled OIDC authentication for the mealie application. |
|
||||
| 2026-04-23 | 9d75346d | Updated the base URL for the recipe application. |
|
||||
|
||||
<Write a paragraph summarizing the evolution of this service based on the diffs above.>
|
||||
|
||||
---
|
||||
|
||||
## Notes
|
||||
Generated by Gremlin on 2026-04-23T14:54:28.043Z
|
||||
Source: swarm/mealie.yaml
|
||||
Review User Guide and Changelog sections
|
||||
- Generated by Gremlin on 2026-04-23T15:28:14.098Z
|
||||
- Source: swarm/mealie.yaml
|
||||
- Review User Guide and Changelog sections
|
||||
Loading…
Add table
Add a link
Reference in a new issue