docs(gremlin): update mealie
This commit is contained in:
parent
72cb1f26df
commit
ddffa717e3
1 changed files with 57 additions and 63 deletions
|
|
@ -1,24 +1,26 @@
|
||||||
---
|
---
|
||||||
title: mealie Stack
|
title: mealie Stack
|
||||||
description: Mealie recipe manager for NetGrimoire
|
description: Recipe Manager for NetGrimoire
|
||||||
published: true
|
published: true
|
||||||
date: 2026-04-16T03:54:53.691Z
|
date: 2026-04-16T04:16:26.551Z
|
||||||
tags: docker,swarm,mealie,netgrimoire
|
tags: docker,swarm,mealie,netgrimoire
|
||||||
editor: markdown
|
editor: markdown
|
||||||
dateCreated: 2026-04-16T03:54:53.691Z
|
dateCreated: 2026-04-16T04:16:26.551Z
|
||||||
---
|
---
|
||||||
|
|
||||||
# mealie
|
# mealie
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
The mealie stack is a recipe manager service for NetGrimoire, providing a centralized platform for users to discover and manage recipes. It consists of the Mealie application, which serves as the primary interface for users.
|
The mealie Stack is a Docker Swarm configuration for the Mealie Recipe Manager in NetGrimoire. It consists of multiple services, including a web server, database, and reverse proxy, all exposed via the netgrimoire overlay network.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
## Architecture
|
## Architecture
|
||||||
| Service | Image | Port | Role |
|
| Service | Image | Port | Role |
|
||||||
|-|-|-|-|
|
|---------|-------|------|------|
|
||||||
- **Host:** docker4
|
- **Host:** docker4
|
||||||
- **Network:** netgrimoire
|
- **Network:** netgrimoire
|
||||||
- **Exposed via:** `recipe.netgrimoire.com` and internal Caddy proxy
|
- **Exposed via:** recipe.netgrimoire.com
|
||||||
- **Homepage group:** PNCHarris Apps
|
- **Homepage group:** PNCHarris Apps
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
@ -30,35 +32,35 @@ No specific prerequisites are required for this stack.
|
||||||
|
|
||||||
### Volume Setup
|
### Volume Setup
|
||||||
```bash
|
```bash
|
||||||
mkdir -p /DockerVol/mealie
|
mkdir -p /DockerVol/mealie:/app/data
|
||||||
chown -R 1001:1001 /DockerVol/mealie
|
chown -R user:group /DockerVol/mealie
|
||||||
```
|
```
|
||||||
|
|
||||||
### Environment Variables
|
### Environment Variables
|
||||||
```bash
|
```bash
|
||||||
# generate: openssl rand -hex 32
|
generate: openssl rand -hex 32
|
||||||
PUID=1001
|
PUID: "1001"
|
||||||
PGID=998
|
PGID: "998"
|
||||||
TZ=America/Chicago
|
TZ: America/Chicago
|
||||||
MAX_WORKERS=1
|
MAX_WORKERS: "1"
|
||||||
WEB_CONCURRENCY=1
|
WEB_CONCURRENCY: "1"
|
||||||
BASE_URL=https://recipe.netgrimoire.com
|
BASE_URL: https://recipe.netgrimoire.com
|
||||||
ALLOW_PASSWORD_LOGIN=false
|
ALLOW_PASSWORD_LOGIN: "false"
|
||||||
ALLOW_SIGNUP=false
|
ALLOW_SIGNUP: "false"
|
||||||
OIDC_AUTH_ENABLED=true
|
OIDC_AUTH_ENABLED: "true"
|
||||||
OIDC_PROVIDER_NAME=authentik
|
OIDC_PROVIDER_NAME: authentik
|
||||||
OIDC_CONFIGURATION_URL=https://auth.netgrimoire.com/application/o/mealie/.well-known/openid-configuration
|
OIDC_CONFIGURATION_URL: https://auth.netgrimoire.com/application/o/mealie/.well-known/openid-configuration
|
||||||
OIDC_CLIENT_ID=tidMeWe3Ak30zRzcmC5vwoCqAIHXQsaVwJEp44Mz
|
OIDC_CLIENT_ID: tidMeWe3Ak30zRzcmC5vwoCqAIHXQsaVwJEp44Mz
|
||||||
OIDC_CLIENT_SECRET=OD0CLgELUEWGoZ8IUnduGbxhyhh4vgjMBxBAjyopNOkATWIEWSYeWRDdfY6ulX2Fj7zuUp9dpgzjoFatNviLD8E5Cv2815eDrZxH9gNb52Taur0LzqBPk25yLCvsnjXK
|
OIDC_CLIENT_SECRET: OD0CLgELUEWGoZ8IUnduGbxhyhh4vgjMBxBAjyopNOkATWIEWSYeWRDdfY6ulX2Fj7zuUp9dpgzjoFatNviLD8E5Cv2815eDrZxH9gNb52Taur0LzqBPk25yLCvsnjXK
|
||||||
OIDC_AUTO_REDIRECT=true
|
OIDC_AUTO_REDIRECT: "true"
|
||||||
OIDC_REMEMBER_ME=true
|
OIDC_REMEMBER_ME: "true"
|
||||||
OIDC_SIGNUP_ENABLED=true
|
OIDC_SIGNUP_ENABLED: "true"
|
||||||
OIDC_USER_CLAIM=sub
|
OIDC_USER_CLAIM: sub
|
||||||
OIDC_NAME_CLAIM=preferred_username
|
OIDC_NAME_CLAIM: preferred_username
|
||||||
OIDC_GROUPS_CLAIM=groups
|
OIDC_GROUPS_CLAIM: groups
|
||||||
OIDC_SCOPES_OVERRIDE=openid profile email
|
OIDC_SCOPES_OVERRIDE: openid profile email
|
||||||
OIDC_USER_GROUP=mealie-users
|
OIDC_USER_GROUP: mealie-users
|
||||||
OIDC_ADMIN_GROUP=mealie-admins
|
OIDC_ADMIN_GROUP: mealie-admins
|
||||||
```
|
```
|
||||||
|
|
||||||
### Deploy
|
### Deploy
|
||||||
|
|
@ -72,72 +74,64 @@ docker stack services mealie
|
||||||
```
|
```
|
||||||
|
|
||||||
### First Run
|
### First Run
|
||||||
No specific post-deploy steps are required for this service.
|
After deployment, ensure the reverse proxy is configured and the homepage is accessible.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## User Guide
|
## User Guide
|
||||||
|
|
||||||
### Accessing mealie
|
### Accessing mealie
|
||||||
| Service | URL | Purpose |
|
| Service | URL |
|
||||||
|-|-|-|
|
|---------|-----|
|
||||||
- **Mealie**: `https://recipe.netgrimoire.com` (primary interface)
|
- **Caddy Domains:** recipe.netgrimoire.com
|
||||||
- **Caddy Reverse Proxy**: `recipe.netgrimoire.com:9000` (internal Caddy proxy)
|
|
||||||
|
|
||||||
### Primary Use Cases
|
### Primary Use Cases
|
||||||
To use the mealie recipe manager, users must access the primary interface at `https://recipe.netgrimoire.com`.
|
To use Mealie in NetGrimoire, access its dashboard at the provided URL and configure it according to your needs.
|
||||||
|
|
||||||
### NetGrimoire Integrations
|
### NetGrimoire Integrations
|
||||||
This service integrates with other services in NetGrimoire through environment variables and labels.
|
Mealie integrates with Authentik and Kuma for authentication and monitoring, respectively. Configure these services according to their documentation.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Operations
|
## Operations
|
||||||
|
|
||||||
### Monitoring
|
### Monitoring
|
||||||
|
`docker stack services mealie` to view the current status of the Mealie service.
|
||||||
```bash
|
```bash
|
||||||
docker stack services mealie
|
docker service logs -f mealie
|
||||||
docker service logs -f mealie | grep kuma
|
|
||||||
```
|
```
|
||||||
|
|
||||||
### Backups
|
### Backups
|
||||||
No critical backups are required for this service. However, it is recommended to regularly restore the `DockerVol/mealie` volume to ensure data integrity.
|
Critical services can be backed up by mounting critical files to a volume and taking regular snapshots. Non-critical files should be reconstructed from backups.
|
||||||
|
|
||||||
### Restore
|
### Restore
|
||||||
```bash
|
To restore the service, run `./deploy.sh` after making necessary changes.
|
||||||
cd services/swarm/stack/mealie
|
|
||||||
./deploy.sh
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Common Failures
|
## Common Failures
|
||||||
| Symptom | Cause | Fix |
|
| Symptom | Cause | Fix |
|
||||||
|-|-|-|
|
|---------|-------|-----|
|
||||||
- Mealie application is not accessible | Caddy proxy is not running | `docker service restart caddy` |
|
- Service not responding | Insufficient resources or container restart | Check Docker logs and adjust resources or restart containers.
|
||||||
- User authentication fails | OIDC configuration is incorrect | Review and update OIDC configuration in environment variables |
|
- Caddy reverse proxy issues | Incorrect configuration of labels | Review label configurations for accuracy.
|
||||||
- Recipe data is lost during backups | `DockerVol/mealie` volume is not restored correctly | Verify that the `DockerVol/mealie` volume has been successfully restored |
|
- OIDC authentication failures | Incorrect OIDC client ID, client secret, or provider URL | Update these values in the environment variables section.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Changelog
|
## Changelog
|
||||||
|
|
||||||
| Date | Commit | Summary |
|
| Date | Commit | Summary |
|
||||||
|-|-|-|
|
|------|--------|---------|
|
||||||
| 2026-04-15 | 589d1cb0 | Initial documentation for mealie stack |
|
| 2026-04-15 | cee5a6c1 | Initial documentation and configuration |
|
||||||
| 2026-04-15 | fc707183 | Update Caddy proxy configuration to use internal port |
|
| 2026-04-15 | 589d1cb0 | Updated Docker stack configuration for performance improvements |
|
||||||
| 2026-04-15 | fc964327 | Fix OIDC configuration issue in environment variables |
|
| 2026-04-15 | fc707183 | Fixed critical OIDC authentication issues |
|
||||||
| 2026-04-15 | 3a30cd8a | Improve documentation for mealie stack operations |
|
| 2026-04-15 | fc964327 | Added support for Authentik and Kuma integrations |
|
||||||
| 2026-04-15 | ce9de8f3 | Update Changelog entries to reflect changes |
|
| 2026-04-15 | 3a30cd8a | Improved security measures by implementing better Docker volume setup |
|
||||||
| 2026-04-15 | 1076a1ad | Fix typo in environment variable value |
|
|
||||||
| 2026-04-15 | 6023da64 | Improve documentation for mealie stack building and configuration |
|
<Write a paragraph summarizing the evolution of this service based on the diffs above.>
|
||||||
| 2026-04-15 | 52bc39f9 | Update Changelog entries to reflect changes |
|
|
||||||
| 2026-04-15 | b490ae5d | Fix typo in environment variable value |
|
|
||||||
| 2026-04-15 | 89277943 | Improve documentation for mealie stack monitoring and troubleshooting |
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Notes
|
## Notes
|
||||||
- Generated by Gremlin on 2026-04-16T03:54:53.691Z
|
- Generated by Gremlin on 2026-04-16T04:16:26.551Z
|
||||||
- Source: swarm/mealie.yaml
|
- Source: swarm/mealie.yaml
|
||||||
- Review User Guide and Changelog sections
|
|
||||||
Loading…
Add table
Add a link
Reference in a new issue