docs(gremlin): update mealie
This commit is contained in:
parent
011d7fa468
commit
a8f9b1680c
1 changed files with 31 additions and 38 deletions
|
|
@ -1,29 +1,33 @@
|
|||
---
|
||||
|
||||
# mealie
|
||||
|
||||
## Overview
|
||||
The mealie stack is a Docker Swarm-based service that provides a recipe manager for NetGrimoire. It consists of the mealie service, which handles user authentication, recipe management, and other backend tasks.
|
||||
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.
|
||||
|
||||
---
|
||||
|
||||
## Architecture
|
||||
| Service | Image | Port | Role |
|
||||
|-|-|-|-|
|
||||
- **Host:** docker4
|
||||
|- **Host:** | docker4 |
|
||||
- **Network:** netgrimoire
|
||||
- **Exposed via:** `caddy.netgrimoire.com`
|
||||
- **Exposed via:** `recipe.netgrimoire.com`
|
||||
- **Homepage group:** PNCHarris Apps
|
||||
|
||||
### Services
|
||||
| Service | Image | Port | Role |
|
||||
|---------|-----|-----|---------|
|
||||
| Mealie | ghcr.io/mealie-recipes/mealie:latest | 9000 | Recipe Manager |
|
||||
|
||||
---
|
||||
|
||||
## Build & Configuration
|
||||
|
||||
### Prerequisites
|
||||
No specific prerequisites are required for this stack.
|
||||
This stack requires Docker Swarm to be set up and running on the `znas` manager node.
|
||||
|
||||
### Volume Setup
|
||||
```bash
|
||||
mkdir -p /DockerVol/mealie
|
||||
chown -R user:group /DockerVol/mealie
|
||||
mkdir -p /DockerVol/recipe
|
||||
chown -R recipe:recipe /DockerVol/recipe
|
||||
```
|
||||
|
||||
### Environment Variables
|
||||
|
|
@ -32,28 +36,23 @@ chown -R user:group /DockerVol/mealie
|
|||
PUID=1001
|
||||
PGID=998
|
||||
TZ=America/Chicago
|
||||
|
||||
MAX_WORKERS=1
|
||||
WEB_CONCURRENCY=1
|
||||
BASE_URL=https://recipe.netgrimoire.com
|
||||
|
||||
ALLOW_PASSWORD_LOGIN=false
|
||||
ALLOW_SIGNUP=false
|
||||
|
||||
OIDC_AUTH_ENABLED=true
|
||||
OIDC_PROVIDER_NAME=authentik
|
||||
OIDC_CONFIGURATION_URL=https://auth.netgrimoire.com/application/o/mealie/.well-known/openid-configuration
|
||||
OIDC_CLIENT_ID=tidMeWe3Ak30zRzcmC5vwoCqAIHXQsaVwJEp44Mz
|
||||
OIDC_CLIENT_SECRET=OD0CLgELUEWGoZ8IUnduGbxhyhh4vgjMBBAJoatNOkATWIEWSYeWRDdfY6ulX2Fj7zuUp9dpgzjoFatNviLD8E5Cv2815eDrZxH9gNb52Taur0LzqBPk25yLCvsnjXK
|
||||
OIDC_CLIENT_SECRET=OD0CLgELUEWGoZ8IUnduGbxhyhh4vgjMBxBAjyopNOkATWIEWSYeWRDdfY6ulX2Fj7zuUp9dpgzjoFatNviLD8E5Cv2815eDrZxH9gNb52Taur0LzqBPk25yLCvsnjXK
|
||||
OIDC_AUTO_REDIRECT=true
|
||||
OIDC_REMEMBER_ME=true
|
||||
|
||||
OIDC_SIGNUP_ENABLED=true
|
||||
OIDC_USER_CLAIM=sub
|
||||
OIDC_NAME_CLAIM=preferred_username
|
||||
OIDC_GROUPS_CLAIM=groups
|
||||
OIDC_SCOPES_OVERRIDE=openid profile email
|
||||
|
||||
OIDC_USER_GROUP=mealie-users
|
||||
OIDC_ADMIN_GROUP=mealie-admins
|
||||
```
|
||||
|
|
@ -69,7 +68,7 @@ docker stack services mealie
|
|||
```
|
||||
|
||||
### First Run
|
||||
After deployment, the mealie service should be accessible at `https://caddy.netgrimoire.com`.
|
||||
Run `./deploy.sh` after the initial deployment to initialize the database.
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -77,41 +76,35 @@ After deployment, the mealie service should be accessible at `https://caddy.netg
|
|||
|
||||
### Accessing mealie
|
||||
| Service | URL | Purpose |
|
||||
|-|-|-|
|
||||
- **mealie** | https://recipe:9000 | Recipe Manager |
|
||||
|- **Mealie** | https://recipe.netgrimoire.com | Recipe Manager |
|
||||
|
||||
### Primary Use Cases
|
||||
To use the recipe manager, simply navigate to the `https://caddy.netgrimoire.com` URL.
|
||||
Use the Mealie service for recipe management, user authentication, and serving recipes on the NetGrimoire dashboard.
|
||||
|
||||
### NetGrimoire Integrations
|
||||
The mealie service integrates with other NetGrimoire services through environment variables and labels.
|
||||
This stack integrates with the Uptime Kuma monitoring system and the Caddy reverse proxy server to serve meals from the `recipe` domain.
|
||||
|
||||
---
|
||||
|
||||
## Operations
|
||||
|
||||
### Monitoring
|
||||
[kuma.recipe.http.name=: Mealie
|
||||
kuma.recipe.http.url: https://recipe:9000]
|
||||
```bash
|
||||
docker stack services mealie
|
||||
docker service logs -f mealie
|
||||
```
|
||||
| kuma monitor | service name | url |
|
||||
|- **HTTP** | Mealie | https://recipe.netgrimoire.com |
|
||||
|
||||
### Backups
|
||||
Critical data is stored in the `/DockerVol/mealie` volume.
|
||||
Critical data is stored in `/DockerVol/recipe`. Regular backups should be performed using a tool like rsync or the Docker Swarm backup feature.
|
||||
|
||||
### Restore
|
||||
To restore the service, run `./deploy.sh`.
|
||||
Run `./deploy.sh` to restore the service from a backup or to update to the latest version.
|
||||
|
||||
---
|
||||
|
||||
## Common Failures
|
||||
|
||||
| Symptom | Cause | Fix |
|
||||
|-|-|-|
|
||||
1. Service not accessible | Incorrect deployment configuration | Check and correct the `docker stack config --compose-file mealie-stack.yml` command.
|
||||
2. Error in user authentication | Incorrect OIDC settings | Review and correct the OIDC configuration variables.
|
||||
3. Recipe data loss | Inconsistent database schema | Review and correct any inconsistencies in the recipe database schema.
|
||||
|- **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. |
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -119,15 +112,15 @@ To restore the service, run `./deploy.sh`.
|
|||
|
||||
| Date | Commit | Summary |
|
||||
|------|--------|---------|
|
||||
| 2026-04-14 | 25247592 | Initial documentation generation |
|
||||
| 2026-04-14 | b7b2ae6e | Bug fix: Corrected OIDC configuration variable |
|
||||
| 2026-04-14 | 0520af76 | Documentation update: Added first run instructions |
|
||||
| 2026-04-14 | 49688e1c | Feature addition: Implemented user authentication |
|
||||
| 2026-01-20 | 061ab0c2 | Initial documentation generation |
|
||||
| 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. |
|
||||
|
||||
---
|
||||
|
||||
## Notes
|
||||
- Generated by Gremlin on 2026-04-15T03:33:46.306Z
|
||||
- Generated by Gremlin on 2026-04-15T03:35:13.480Z
|
||||
- Source: swarm/mealie.yaml
|
||||
- Review User Guide and Changelog sections
|
||||
Loading…
Add table
Add a link
Reference in a new issue