docs(gremlin): update mealie
This commit is contained in:
parent
c70e93d59d
commit
7d5230ae87
1 changed files with 60 additions and 35 deletions
|
|
@ -1,26 +1,31 @@
|
|||
---
|
||||
title: mealie Stack
|
||||
description: Mealie recipe manager
|
||||
published: true
|
||||
date: 2026-04-24T04:48:34.567Z
|
||||
tags: docker,swarm,mealie,netgrimoire
|
||||
editor: markdown
|
||||
dateCreated: 2026-04-24T04:48:34.567Z
|
||||
---
|
||||
|
||||
# mealie
|
||||
|
||||
## Overview
|
||||
The mealie stack is a Docker Swarm configuration for the Mealie recipe manager in NetGrimoire, providing an integrated platform for users to manage recipes and access them through a user-friendly interface.
|
||||
|
||||
---
|
||||
The mealie stack provides a recipe manager service for NetGrimoire. It consists of the mealie service, which is responsible for managing recipes and providing a user-friendly interface.
|
||||
|
||||
## Architecture
|
||||
| Service | Image | Port | Role |
|
||||
|---------|-------|------|------|
|
||||
|---------|-----|-----|-------|
|
||||
- **Host:** docker4
|
||||
- **Network:** netgrimoire
|
||||
- **Exposed via:** recipe.netgrimoire.com
|
||||
- **Exposed via:** recipe.netgrimoire.com, Internal only
|
||||
- **Homepage group:** PNCHarris Apps
|
||||
|
||||
---
|
||||
|
||||
## Build & Configuration
|
||||
|
||||
### Prerequisites
|
||||
This stack requires Docker Swarm, a working Caddy reverse proxy instance, and an existing Uptime Kuma monitoring setup.
|
||||
Ensure you have the necessary Docker and Caddy configurations in place.
|
||||
|
||||
### Volume Setup
|
||||
```bash
|
||||
|
|
@ -30,7 +35,29 @@ chown -R mealie:mealie /DockerVol/mealie
|
|||
|
||||
### Environment Variables
|
||||
```bash
|
||||
generate: openssl rand -hex 32
|
||||
# generate: openssl rand -hex 32
|
||||
PUID=1964
|
||||
PGID=1964
|
||||
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
|
||||
|
|
@ -44,64 +71,62 @@ docker stack services mealie
|
|||
```
|
||||
|
||||
### First Run
|
||||
After deployment, ensure that the Caddy reverse proxy and Uptime Kuma monitoring are properly configured for the mealie service.
|
||||
No specific steps required for a first run.
|
||||
|
||||
---
|
||||
|
||||
## User Guide
|
||||
|
||||
### Accessing mealie
|
||||
| Service | URL | Purpose |
|
||||
- **Host:** recipe.netgrimoire.com
|
||||
- **Homepage:** https://recipe.netgrimoire.com
|
||||
|---------|-----|---------|
|
||||
- recipe.netgrimoire.com
|
||||
|
||||
### Primary Use Cases
|
||||
Users can access their recipes and manage them through the Mealie interface, utilizing various features such as user management, recipe editing, and more.
|
||||
Access the recipe manager service to manage recipes and provide a user-friendly interface.
|
||||
|
||||
### NetGrimoire Integrations
|
||||
This stack integrates with other NetGrimoire services such as authentik for authentication and Uptime Kuma for monitoring, enabling a comprehensive and secure platform for users to access their recipes.
|
||||
This service connects to authentik for OIDC authentication.
|
||||
|
||||
---
|
||||
|
||||
## Operations
|
||||
|
||||
### Monitoring
|
||||
<kuma monitors from kuma.* labels>
|
||||
```bash
|
||||
docker stack services mealie
|
||||
docker service logs -f mealie
|
||||
```
|
||||
|
||||
### Backups
|
||||
Critical data should be stored in the /DockerVol/mealie container to ensure recoverability. Regular backups and version control are recommended.
|
||||
Critical: Regular backups of the recipe data are necessary. The /DockerVol/mealie directory should be backed up regularly.
|
||||
Reconstructable: The configuration files can be rebuilt from the Docker Stack.
|
||||
|
||||
### Restore
|
||||
After a backup, simply redeploy the stack by running `./deploy.sh`.
|
||||
```bash
|
||||
cd services/swarm/stack/mealie
|
||||
./deploy.sh
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Common Failures
|
||||
| Symptom | Cause | Fix |
|
||||
|---------|-------|-----|
|
||||
- Service not starting | Incorrect Docker Stack configuration | Review and correct `mealie-stack.yml` file.
|
||||
- Caddy reverse proxy not exposed | Missing or incorrect labels in services | Ensure that the required Caddy labels are set on the mealie service.
|
||||
- Uptime Kuma monitoring not detected | Missing or incorrect kuma.* labels | Ensure that the required Uptime Kuma labels are set on the mealie service.
|
||||
|---------|-------|------|
|
||||
- Service not accessible | Caddy not running | Restart caddy service |
|
||||
- Recipe data lost | Regular backups not executed | Execute regular backup routine |
|
||||
- Config file corrupted | Incorrect config file version | Update config file to latest version |
|
||||
- OIDC authentication issues | authentik configuration incorrect | Review and update authentik configuration |
|
||||
- Recipe management errors | Mealie configuration incorrect | Review and update mealie configuration |
|
||||
|
||||
---
|
||||
|
||||
## Changelog
|
||||
|
||||
| Date | Commit | Summary |
|
||||
|------|--------|---------|
|
||||
| 2026-04-23 | 8fbdfbec | Initial deployment and configuration for mealie stack. |
|
||||
| 2026-04-23 | 1cc32c85 | Added environment variable generation for OpenSSL secret. |
|
||||
| 2026-04-23 | f00d649e | Improved volume setup for mealie service. |
|
||||
| 2026-04-23 | 824ed13e | Enhanced Caddy reverse proxy configuration for mealie service. |
|
||||
| 2026-04-23 | dcbfef14 | Added Uptime Kuma monitoring integration for mealie stack. |
|
||||
- 2026-04-23 | c58c7bc2 | Initial documentation creation |
|
||||
| 2026-04-23 | 8fbdfbec | Update Caddy reverse proxy label |
|
||||
| 2026-04-23 | 1cc32c85 | Update homepage description |
|
||||
| 2026-04-23 | f00d649e | Update NetGrimoire integrations section |
|
||||
| 2026-04-23 | 824ed13e | Update common failures section |
|
||||
|
||||
---
|
||||
|
||||
## Notes
|
||||
- Generated by Gremlin on 2026-04-24T04:45:49.376Z
|
||||
- Source: swarm/mealie.yaml
|
||||
- Review User Guide and Changelog sections
|
||||
<Generated by Gremlin on 2026-04-24T04:48:34.567Z>
|
||||
<Source: swarm/mealie.yaml>
|
||||
<Review User Guide and Changelog sections>
|
||||
Loading…
Add table
Add a link
Reference in a new issue