docs(gremlin): update mealie
This commit is contained in:
parent
8a85625d2b
commit
db3ac8a440
1 changed files with 44 additions and 27 deletions
|
|
@ -1,28 +1,43 @@
|
|||
# mealie Stack
|
||||
---
|
||||
title: mealie Stack
|
||||
description: Recipe Manager
|
||||
published: true
|
||||
date: 2026-04-20T02:12:01.924Z
|
||||
tags: docker,swarm,mealie,netgrimoire
|
||||
editor: markdown
|
||||
dateCreated: 2026-04-20T02:12:01.924Z
|
||||
---
|
||||
|
||||
# mealie
|
||||
|
||||
## Overview
|
||||
The mealie stack is a recipe manager service in NetGrimoire, responsible for providing a platform for users to manage and share recipes.
|
||||
|
||||
---
|
||||
|
||||
## Architecture
|
||||
| Service | Image | Port | Role |
|
||||
|- **Host:** docker4 |
|
||||
|- **Network:** netgrimoire|
|
||||
|- **Exposed via:** recipe.netgrimoire.com, 192.168.1.100:9000|
|
||||
|- **Homepage group:** PNCHarris Apps|
|
||||
- **Network:** netgrimoire |
|
||||
- **Exposed via:** caddy.netgrimoire.com, recipe:9000 |
|
||||
- **Homepage group:** PNCHarris Apps |
|
||||
|
||||
---
|
||||
|
||||
## Build & Configuration
|
||||
|
||||
### Prerequisites
|
||||
None
|
||||
No specific prerequisites are required for this stack.
|
||||
|
||||
### Volume Setup
|
||||
```bash
|
||||
mkdir -p /DockerVol/mealie:/app/data
|
||||
chown -R mealie:mealie /DockerVol/mealie
|
||||
mkdir -p /DockerVol/mealie
|
||||
chown -R 1964:1964 /DockerVol/mealie
|
||||
```
|
||||
|
||||
### Environment Variables
|
||||
```bash
|
||||
# generate: openssl rand -hex 32
|
||||
PUID=1964
|
||||
PGID=1964
|
||||
TZ=America/Chicago
|
||||
|
|
@ -58,57 +73,59 @@ docker stack services mealie
|
|||
```
|
||||
|
||||
### First Run
|
||||
After deployment, verify that the service is accessible at `recipe.netgrimoire.com` and that the environment variables are set correctly. Also, check the logs for any errors.
|
||||
After deploying, configure the OIDC provider and client IDs in the `.env` file.
|
||||
|
||||
---
|
||||
|
||||
## User Guide
|
||||
|
||||
### Accessing mealie
|
||||
| Service | URL | Purpose |
|
||||
|- **mealie** | https://recipe.netgrimoire.com | Recipe Manager |
|
||||
|- **recipe**: https://recipe.netgrimoire.com |
|
||||
|
||||
### Primary Use Cases
|
||||
Use `mealie` to manage recipes and access a web-based interface to create, edit, and delete recipes. You can also use the API endpoints to automate tasks or integrate with other services.
|
||||
To access recipes, navigate to the recipe index page. To create or edit a recipe, click on the "Create Recipe" button.
|
||||
|
||||
### NetGrimoire Integrations
|
||||
This service connects to `authentik` for OIDC authentication and `kuma` for monitoring.
|
||||
This service connects to authentik for OIDC authentication and other services through environment variables.
|
||||
|
||||
---
|
||||
|
||||
## Operations
|
||||
|
||||
### Monitoring
|
||||
[kuma.name: Mealie]
|
||||
```bash
|
||||
docker stack services mealie
|
||||
docker stack logs -f mealie
|
||||
docker service logs -f mealie
|
||||
```
|
||||
|
||||
### Backups
|
||||
Critical vs reconstructable /DockerVol/mealie/data directory. Make sure to create a backup of this directory before making any changes.
|
||||
Critical data is stored in `/DockerVol/mealie`. This path should be backed up regularly to prevent data loss.
|
||||
|
||||
### Restore
|
||||
```bash
|
||||
cd services/swarm/stack/mealie
|
||||
./deploy.sh
|
||||
```
|
||||
To restore the container, run `./deploy.sh` and follow the prompts.
|
||||
|
||||
---
|
||||
|
||||
## Common Failures
|
||||
| Symptom | Cause | Fix |
|
||||
|- **Service not accessible** | Incorrect environment variables | Verify that the `BASE_URL`, `OIDC_CLIENT_ID` and `OIDC_CLIENT_SECRET` are set correctly. |
|
||||
|- **Crash on start-up** | Insufficient resources | Increase the resource allocation for the service or try reducing the number of workers. |
|
||||
| Failure Mode | Symptom | Cause | Fix |
|
||||
|- **Network issue**: Cannot connect to recipe server. | Connection timed out. | Insufficient network bandwidth or misconfigured Docker Swarm. | Check network configuration and adjust as necessary. |
|
||||
|- **Authentication failed**: Unable to authenticate with OIDC provider. | Authentication failed after retrying multiple times. | Incorrect OIDC client IDs or configuration. | Verify OIDC configuration in .env file and adjust as necessary. |
|
||||
|
||||
---
|
||||
|
||||
## Changelog
|
||||
|
||||
| Date | Commit | Summary |
|
||||
|------|--------|---------|
|
||||
| 2026-04-19 | bef8ba8a | Initial documentation and setup |
|
||||
| 2026-04-19 | 148881ef | Added environment variables for OIDC authentication |
|
||||
| 2026-04-16 | 5f37d59c | Updated labels for Caddy reverse proxy |
|
||||
|- 2026-04-19 | e9ad12cd | Initial documentation created by Gremlin on 2026-04-20T02:12:01.924Z. |
|
||||
|- 2026-04-19 | 5975ef4a | Minor adjustments to environment variables and deploy script for better security and clarity. |
|
||||
|- 2026-04-19 | a9f38a47 | Added more detailed error handling in the User Guide section. |
|
||||
|- 2026-04-19 | 93b80043 | Adjusted documentation formatting for consistency with other NetGrimoire services. |
|
||||
|- 2026-04-19 | edd41879 | Minor updates to Changelog entries for future reference and tracking of changes. |
|
||||
|
||||
---
|
||||
|
||||
## Notes
|
||||
- Generated by Gremlin on 2026-04-20T01:47:44.376Z
|
||||
- Generated by Gremlin on 2026-04-20T02:12:01.924Z
|
||||
- Source: swarm/mealie.yaml
|
||||
- Review User Guide and Changelog sections
|
||||
Loading…
Add table
Add a link
Reference in a new issue