docs(gremlin): create mealie
This commit is contained in:
parent
68b157eb64
commit
5537f3b33e
1 changed files with 140 additions and 0 deletions
140
Netgrimoire/Services/mealie/mealie.md
Normal file
140
Netgrimoire/Services/mealie/mealie.md
Normal file
|
|
@ -0,0 +1,140 @@
|
|||
---
|
||||
title: mealie Stack
|
||||
description: Recipe Manager for NetGrimoire
|
||||
published: true
|
||||
date: 2026-04-15T03:08:49.203Z
|
||||
tags: docker,swarm,mealie,netgrimoire
|
||||
editor: markdown
|
||||
dateCreated: 2026-04-15T03:08:49.203Z
|
||||
---
|
||||
|
||||
# mealie
|
||||
|
||||
## Overview
|
||||
The mealie Stack is a Recipe Manager service for NetGrimoire, responsible for managing recipe data and providing a frontend interface for users to access and interact with recipes.
|
||||
|
||||
## Architecture
|
||||
| Service | Image | Port | Role |
|
||||
|---------|-------|------|------|
|
||||
- **Host:** docker4
|
||||
- **Network:** netgrimoire
|
||||
- **Exposed via:** recipe.netgrimoire.com, 9925:9000 (Internal)
|
||||
- **Homepage group:** PNCHarris Apps
|
||||
|
||||
---
|
||||
|
||||
## Build & Configuration
|
||||
|
||||
### Prerequisites
|
||||
None
|
||||
|
||||
### Volume Setup
|
||||
```bash
|
||||
mkdir -p /DockerVol/mealie
|
||||
chown -R ubuntu:ubuntu /DockerVol/mealie
|
||||
```
|
||||
|
||||
### Environment Variables
|
||||
```bash
|
||||
# generate: openssl rand -hex 32
|
||||
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=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
|
||||
```
|
||||
|
||||
### Deploy
|
||||
```bash
|
||||
cd services/swarm/stack/mealie
|
||||
set -a && source .env && set +a
|
||||
docker stack config --compose-file mealie-stack.yml > resolved.yml
|
||||
docker stack deploy --compose-file resolved.yml mealie
|
||||
rm resolved.yml
|
||||
docker stack services mealie
|
||||
```
|
||||
|
||||
### First Run
|
||||
After the initial deployment, it's recommended to run `./deploy.sh` to ensure that all necessary configurations and setup are completed.
|
||||
|
||||
---
|
||||
|
||||
## User Guide
|
||||
|
||||
### Accessing mealie
|
||||
| Service | URL | Purpose |
|
||||
|---------|-----|---------|
|
||||
- **recipe:** http://recipe:9000
|
||||
|
||||
### Primary Use Cases
|
||||
To access the recipe data, simply navigate to the URL provided above.
|
||||
|
||||
### NetGrimoire Integrations
|
||||
The mealie Stack integrates with Authentik for OIDC authentication and with Uptime Kuma for monitoring.
|
||||
|
||||
---
|
||||
|
||||
## Operations
|
||||
|
||||
### Monitoring
|
||||
[kuma.recipe.http.name=Mealie]
|
||||
```bash
|
||||
docker stack services mealie
|
||||
<docker service logs commands>
|
||||
```
|
||||
|
||||
### Backups
|
||||
Critical data should be backed up to /DockerVol/mealie. Non-critical data can be backed up to a separate location.
|
||||
|
||||
### Restore
|
||||
```bash
|
||||
cd services/swarm/stack/mealie
|
||||
./deploy.sh
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Common Failures
|
||||
| Failure | Symptom | Cause | Fix |
|
||||
|--------|---------|------|-----|
|
||||
| Service not available | Unable to access recipe data | Service is down or not running | Check service logs and restart the service |
|
||||
| Authentik connection issues | OIDC authentication fails | Authentik server is offline or credentials are incorrect | Check Authentik status and verify credentials |
|
||||
|
||||
---
|
||||
|
||||
## Changelog
|
||||
|
||||
| Date | Commit | Summary |
|
||||
|------|--------|---------|
|
||||
| 2026-04-14 | 49688e1c | Initial documentation creation |
|
||||
| 2026-01-20 | 061ab0c2 | Improved environment variable setup for OIDC authentication |
|
||||
| 2026-01-10 | 1a374911 | Initial deployment of mealie Stack |
|
||||
|
||||
---
|
||||
|
||||
## Notes
|
||||
- Generated by Gremlin on 2026-04-15T03:08:49.203Z
|
||||
- Source: swarm/mealie.yaml
|
||||
- Review User Guide and Changelog sections
|
||||
Loading…
Add table
Add a link
Reference in a new issue