docs(gremlin): update mealie
This commit is contained in:
parent
9beab39b7a
commit
011d7fa468
1 changed files with 32 additions and 41 deletions
|
|
@ -1,16 +1,16 @@
|
|||
---
|
||||
|
||||
# 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 SSO.
|
||||
|
||||
---
|
||||
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.
|
||||
|
||||
## Architecture
|
||||
| Service | Image | Port | Role |
|
||||
|---------|-------|------|------|
|
||||
|-|-|-|-|
|
||||
- **Host:** docker4
|
||||
- **Network:** netgrimoire
|
||||
- **Exposed via:** `recipe.netgrimoire.com`
|
||||
- **Exposed via:** `caddy.netgrimoire.com`
|
||||
- **Homepage group:** PNCHarris Apps
|
||||
|
||||
---
|
||||
|
|
@ -18,12 +18,12 @@ The mealie stack is a Docker Swarm-based service that provides a recipe manager
|
|||
## Build & Configuration
|
||||
|
||||
### Prerequisites
|
||||
None specified
|
||||
No specific prerequisites are required for this stack.
|
||||
|
||||
### Volume Setup
|
||||
```bash
|
||||
mkdir -p /DockerVol/mealie:/app/data
|
||||
chown -R nobody:nobody /DockerVol/mealie
|
||||
mkdir -p /DockerVol/mealie
|
||||
chown -R user:group /DockerVol/mealie
|
||||
```
|
||||
|
||||
### Environment Variables
|
||||
|
|
@ -44,7 +44,7 @@ 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_CLIENT_SECRET=OD0CLgELUEWGoZ8IUnduGbxhyhh4vgjMBBAJoatNOkATWIEWSYeWRDdfY6ulX2Fj7zuUp9dpgzjoFatNviLD8E5Cv2815eDrZxH9gNb52Taur0LzqBPk25yLCvsnjXK
|
||||
OIDC_AUTO_REDIRECT=true
|
||||
OIDC_REMEMBER_ME=true
|
||||
|
||||
|
|
@ -69,9 +69,7 @@ docker stack services mealie
|
|||
```
|
||||
|
||||
### First Run
|
||||
```bash
|
||||
./deploy.sh
|
||||
```
|
||||
After deployment, the mealie service should be accessible at `https://caddy.netgrimoire.com`.
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -79,49 +77,41 @@ docker stack services mealie
|
|||
|
||||
### Accessing mealie
|
||||
| Service | URL | Purpose |
|
||||
- **recipe.netgrimoire.com** | Internal only | Recipe Manager |
|
||||
|-|-|-|
|
||||
- **mealie** | https://recipe:9000 | Recipe Manager |
|
||||
|
||||
### Primary Use Cases
|
||||
To use the recipe manager, access `recipe.netgrimoire.com` and log in with your NetGrimoire credentials.
|
||||
To use the recipe manager, simply navigate to the `https://caddy.netgrimoire.com` URL.
|
||||
|
||||
### NetGrimoire Integrations
|
||||
The mealie service connects to NetGrimoire through the following services:
|
||||
- authentik (OIDC provider)
|
||||
The mealie service integrates with other NetGrimoire services through environment variables and labels.
|
||||
|
||||
---
|
||||
|
||||
## Operations
|
||||
|
||||
### Monitoring
|
||||
[kuma.recipe.http.name=: Mealie
|
||||
kuma.recipe.http.url: https://recipe:9000]
|
||||
```bash
|
||||
docker stack services mealie
|
||||
<docker service logs commands>
|
||||
docker service logs -f mealie
|
||||
```
|
||||
|
||||
### Backups
|
||||
Critical: `/DockerVol/mealie`
|
||||
Reconstructable: None
|
||||
Critical data is stored in the `/DockerVol/mealie` volume.
|
||||
|
||||
### Restore
|
||||
```bash
|
||||
cd services/swarm/stack/mealie
|
||||
./deploy.sh
|
||||
```
|
||||
To restore the service, run `./deploy.sh`.
|
||||
|
||||
---
|
||||
|
||||
## Common Failures
|
||||
- **Symptom:** Mealie service not responding.
|
||||
- **Cause:** Inadequate resources or misconfigured environment variables.
|
||||
- **Fix:** Increase resources or verify and correct environment variables.
|
||||
|
||||
- **Symptom:** Failed OIDC authentication.
|
||||
- **Cause:** Incorrect OIDC configuration or client secret mismatch.
|
||||
- **Fix:** Review and update OIDC configuration or regenerate client secrets.
|
||||
|
||||
- **Symptom:** Mealie service not logging into NetGrimoire.
|
||||
- **Cause:** Incorrect credentials or authentication setup.
|
||||
- **Fix:** Verify and correct credentials, or enable local auth/login.
|
||||
| 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.
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -129,14 +119,15 @@ cd services/swarm/stack/mealie
|
|||
|
||||
| Date | Commit | Summary |
|
||||
|------|--------|---------|
|
||||
| 2026-04-14 | b7b2ae6e | Initial documentation |
|
||||
| 2026-04-14 | 0520af76 | Migrated to Docker Swarm configuration |
|
||||
| 2026-04-14 | 49688e1c | Updated environment variables and deploy script |
|
||||
| 2026-01-20 | 061ab0c2 | Changed default port configuration |
|
||||
| 2026-01-10 | 1a374911 | Introduced support for local auth/login |
|
||||
| 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 |
|
||||
|
||||
---
|
||||
|
||||
## Notes
|
||||
- Generated by Gremlin on 2026-04-15T03:29:01.105Z
|
||||
- Source: swarm/mealie.yaml
|
||||
- Generated by Gremlin on 2026-04-15T03:33:46.306Z
|
||||
- Source: swarm/mealie.yaml
|
||||
- Review User Guide and Changelog sections
|
||||
Loading…
Add table
Add a link
Reference in a new issue