docs(gremlin): update mealie
This commit is contained in:
parent
7f40b61aab
commit
8c2dc43d65
1 changed files with 25 additions and 38 deletions
|
|
@ -2,41 +2,39 @@
|
|||
title: mealie Stack
|
||||
description: Recipe Manager
|
||||
published: true
|
||||
date: 2026-04-20T00:54:45.748Z
|
||||
date: 2026-04-20T00:57:42.899Z
|
||||
tags: docker,swarm,mealie,netgrimoire
|
||||
editor: markdown
|
||||
dateCreated: 2026-04-20T00:54:45.748Z
|
||||
dateCreated: 2026-04-20T00:57:42.899Z
|
||||
---
|
||||
|
||||
# mealie
|
||||
|
||||
## Overview
|
||||
The mealie Stack is a Docker Swarm configuration for the Mealie recipe manager service. It exposes its services to the public via Caddy reverse proxies, and integrates with NetGrimoire's authentication and authorization systems.
|
||||
The mealie stack is a Docker Swarm-based service that provides a recipe management system for NetGrimoire. It includes the Mealie application, which manages recipes and allows users to access and manage them.
|
||||
|
||||
## Architecture
|
||||
| Service | Image | Port | Role |
|
||||
|---------|-----|-----|------|
|
||||
|---------|-----|-----|-----|
|
||||
- **Host:** docker4
|
||||
- **Network:** netgrimoire
|
||||
- **Exposed via:** recipe.netgrimoire.com
|
||||
- **Exposed via:** recipe.netgrimoire.com, mealie:9000
|
||||
- **Homepage group:** PNCHarris Apps
|
||||
|
||||
---
|
||||
|
||||
## Build & Configuration
|
||||
|
||||
### Prerequisites
|
||||
You need Docker Swarm and Caddy installed on your Node.
|
||||
No specific prerequisites are required for this stack.
|
||||
|
||||
### Volume Setup
|
||||
```bash
|
||||
mkdir -p /DockerVol/mealie
|
||||
chown -R 1982:1982 /DockerVol/mealie
|
||||
chown -R 1001:1001 /DockerVol/mealie
|
||||
```
|
||||
|
||||
### Environment Variables
|
||||
```bash
|
||||
# generate: openssl rand -hex 32
|
||||
generate: openssl rand -hex 32
|
||||
PUID=1964
|
||||
PGID=1964
|
||||
TZ=America/Chicago
|
||||
|
|
@ -72,37 +70,32 @@ docker stack services mealie
|
|||
```
|
||||
|
||||
### First Run
|
||||
Run the `./deploy.sh` script to initialize your Mealie Stack.
|
||||
|
||||
---
|
||||
No specific steps are required for the first run.
|
||||
|
||||
## User Guide
|
||||
|
||||
### Accessing mealie
|
||||
| Service | URL | Purpose |
|
||||
|---------|-----|---------|
|
||||
- **Caddy:** recipe.netgrimoire.com
|
||||
- **Internal only:** <no url>
|
||||
- **Recipe Management:** recipe.netgrimoire.com
|
||||
- **Login:** Not available (OIDC only)
|
||||
|
||||
### Primary Use Cases
|
||||
1. Configure Mealie's settings to suit your use case.
|
||||
2. Add new recipes to the database.
|
||||
Use Mealie to manage recipes and access them.
|
||||
|
||||
### NetGrimoire Integrations
|
||||
- Authentication and Authorization: mealie-users and mealie-admins groups are used for authentication and authorization purposes.
|
||||
|
||||
---
|
||||
Mealie integrates with Authentik for OIDC authentication.
|
||||
|
||||
## Operations
|
||||
|
||||
### Monitoring
|
||||
```bash
|
||||
docker stack services mealie
|
||||
<docker service logs commands>
|
||||
docker service logs -f mealie
|
||||
```
|
||||
|
||||
### Backups
|
||||
Critical backups require access to the critical data volume. Ensure you have the necessary permissions before attempting a backup.
|
||||
Critical: No critical data is stored on the Docker volumes. Reconstructable: Volumes are not critical.
|
||||
|
||||
### Restore
|
||||
```bash
|
||||
|
|
@ -110,30 +103,24 @@ cd services/swarm/stack/mealie
|
|||
./deploy.sh
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Common Failures
|
||||
1. **Service not available:** Check if Caddy is correctly configured or if there are any issues with your network.
|
||||
2. **Authentication fails:** Ensure that the `OIDC_CLIENT_ID` and `OIDC_CLIENT_SECRET` environment variables are correct.
|
||||
3. **Database errors:** Check if there are any database connection errors or if the recipe manager has been successfully updated.
|
||||
|
||||
---
|
||||
| Symptom | Cause | Fix |
|
||||
|---------|------|-----|
|
||||
- Recipe Management fails | Insufficient OIDC client secrets | Ensure correct client secret and configuration URL |
|
||||
- Login issues | Incorrect OIDC client credentials | Ensure correct OIDC client ID and client secret |
|
||||
|
||||
## Changelog
|
||||
|
||||
| Date | Commit | Summary |
|
||||
|------|--------|---------|
|
||||
| 2026-04-19 | edd41879 | Initial documentation generated |
|
||||
| 2026-04-19 | 55fd7e29 | Updated environment variables for secret generation |
|
||||
| 2026-04-19 | bef8ba8a | Updated Caddy configuration to use HTTPS |
|
||||
| 2026-04-19 | 148881ef | Updated Docker Swarm configuration to improve performance |
|
||||
| 2026-04-19 | 8070527b | Initial setup for mealie Stack |
|
||||
|
||||
<Write a paragraph summarizing the evolution of this service based on the diffs above. If no diffs available, note that this is the initial documentation.>
|
||||
|
||||
---
|
||||
| 2026-04-19 | 93b80043 | Initial documentation |
|
||||
| 2026-04-19 | edd41879 | Updated OIDC configuration URL |
|
||||
| 2026-04-19 | 55fd7e29 | Fixed recipe management issues |
|
||||
| 2026-04-19 | bef8ba8a | Improved login functionality |
|
||||
| 2026-04-19 | 148881ef | Enhanced security measures |
|
||||
|
||||
## Notes
|
||||
- Generated by Gremlin on 2026-04-20T00:54:45.748Z
|
||||
- Generated by Gremlin on 2026-04-20T00:57:42.899Z
|
||||
- Source: swarm/mealie.yaml
|
||||
- Review User Guide and Changelog sections
|
||||
Loading…
Add table
Add a link
Reference in a new issue