docs(gremlin): update mealie
This commit is contained in:
parent
8b855fb9a8
commit
61b9b8f0c1
1 changed files with 50 additions and 60 deletions
|
|
@ -1,39 +1,40 @@
|
||||||
# mealie Stack
|
---
|
||||||
description: Recipe Manager
|
title: mealie Stack
|
||||||
|
description: Recipe Manager in NetGrimoire
|
||||||
published: true
|
published: true
|
||||||
date: 2026-04-23T15:28:56.774Z
|
date: 2026-04-23T16:06:42.106Z
|
||||||
tags: docker,swarm,mealie,netgrimoire
|
tags: docker,swarm,mealie,netgrimoire
|
||||||
editor: markdown
|
editor: markdown
|
||||||
dateCreated: 2026-04-23T15:28:56.774Z
|
dateCreated: 2026-04-23T16:06:42.106Z
|
||||||
|
---
|
||||||
|
|
||||||
|
# mealie
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
The mealie stack provides a Recipe Manager service in NetGrimoire. It includes the mealie service, which manages recipes and allows users to access them.
|
The mealie stack is a Docker Swarm-based recipe manager in NetGrimoire. It provides a centralized platform for users to discover, access, and share recipes.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Architecture
|
## Architecture
|
||||||
| Service | Image | Port | Role |
|
| Service | Image | Port | Role |
|
||||||
|---------|-----|-----|------|
|
|-|-|-|-|
|
||||||
- **Host:** docker4
|
- **Host:** docker4
|
||||||
- **Network:** netgrimoire
|
- **Network:** netgrimoire
|
||||||
- **Exposed via:** recipe.netgrimoire.com, recipe:9000
|
- **Exposed via:** `recipe.netgrimoire.com`, `recipe:9000`
|
||||||
- **Homepage group:** PNCHarris Apps
|
- **Homepage group:** PNCHarris Apps
|
||||||
|
|
||||||
---
|
---
|
||||||
|
### Build & Configuration
|
||||||
|
|
||||||
## Build & Configuration
|
#### Prerequisites
|
||||||
|
|
||||||
### Prerequisites
|
|
||||||
No specific prerequisites are required for this stack.
|
No specific prerequisites are required for this stack.
|
||||||
|
|
||||||
### Volume Setup
|
#### Volume Setup
|
||||||
```bash
|
```bash
|
||||||
mkdir -p /DockerVol/mealie
|
mkdir -p /DockerVol/mealie
|
||||||
chown -R mealie:mealie /DockerVol/mealie
|
chown -R mealie:mealie /DockerVol/mealie
|
||||||
```
|
```
|
||||||
|
|
||||||
### Environment Variables
|
#### Environment Variables
|
||||||
```bash
|
```
|
||||||
PUID=1964
|
PUID=1964
|
||||||
PGID=1964
|
PGID=1964
|
||||||
TZ=America/Chicago
|
TZ=America/Chicago
|
||||||
|
|
@ -58,7 +59,7 @@ OIDC_USER_GROUP=mealie-users
|
||||||
OIDC_ADMIN_GROUP=mealie-admins
|
OIDC_ADMIN_GROUP=mealie-admins
|
||||||
```
|
```
|
||||||
|
|
||||||
### Deploy
|
#### Deploy
|
||||||
```bash
|
```bash
|
||||||
cd services/swarm/stack/mealie
|
cd services/swarm/stack/mealie
|
||||||
set -a && source .env && set +a
|
set -a && source .env && set +a
|
||||||
|
|
@ -68,71 +69,60 @@ rm resolved.yml
|
||||||
docker stack services mealie
|
docker stack services mealie
|
||||||
```
|
```
|
||||||
|
|
||||||
### First Run
|
#### First Run
|
||||||
Perform the following steps after deploying the stack:
|
After deployment, the recipe manager should be accessible at `recipe.netgrimoire.com`. Users can access their account and start exploring recipes.
|
||||||
- Initialize the database
|
|
||||||
- Create any necessary roles or users
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
### User Guide
|
||||||
|
|
||||||
## User Guide
|
#### Accessing mealie
|
||||||
|
|
||||||
### Accessing mealie
|
|
||||||
| Service | URL | Purpose |
|
| Service | URL | Purpose |
|
||||||
|---------|-----|---------|
|
|-|-|-|
|
||||||
recipe.netgrimoire.com - Access to the Recipe Manager dashboard
|
- **Recipe Manager:** `recipe.netgrimoire.com`
|
||||||
mealie:9000 - Access to the recipe data API
|
- **Login/Signup:** `/login`, `/signup`
|
||||||
|
|
||||||
### Primary Use Cases
|
#### Primary Use Cases
|
||||||
- Manage recipes and access them through the Recipe Manager dashboard.
|
Users can discover, access, and share recipes. They can also manage their account settings and permissions.
|
||||||
- Utilize the recipe data API for programmatic access to recipes.
|
|
||||||
|
|
||||||
### NetGrimoire Integrations
|
#### NetGrimoire Integrations
|
||||||
- This service connects to authentik for OIDC authentication.
|
The recipe manager integrates with other services in NetGrimoire, including authentication providers (`authentik`) and monitoring tools (`Uptime Kuma`).
|
||||||
|
|
||||||
---
|
---
|
||||||
|
### Operations
|
||||||
|
|
||||||
## Operations
|
#### Monitoring
|
||||||
|
|
||||||
### Monitoring
|
|
||||||
```bash
|
```bash
|
||||||
docker stack services mealie
|
docker stack services mealie
|
||||||
docker service logs -f mealie
|
docker service logs -f mealie
|
||||||
```
|
```
|
||||||
|
|
||||||
### Backups
|
#### Backups
|
||||||
Store backups of the /DockerVol/mealie directory in a secure location outside of Docker Swarm.
|
Critical data is stored on `/DockerVol/mealie`. Regular backups should be performed to ensure data integrity.
|
||||||
|
|
||||||
### Restore
|
#### Restore
|
||||||
```bash
|
After a backup, the recipe manager can be restored by running `./deploy.sh`.
|
||||||
cd services/swarm/stack/mealie
|
|
||||||
./deploy.sh
|
|
||||||
```
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
### Common Failures
|
||||||
## Common Failures
|
1. **Symptom:** Service is not accessible.
|
||||||
- **Service not available**: The service may be down due to high traffic or maintenance. Check the status of the service and wait for it to come back online.
|
**Cause:** Insufficient permissions or network issues.
|
||||||
- **Recipe data corruption**: Corrupted recipe data can lead to errors when accessing recipes. Regularly backup the /DockerVol/mealie directory to prevent this issue.
|
**Fix:** Verify that the service is exposed correctly and has sufficient permissions.
|
||||||
- **OIDC authentication issues**: Problems with OIDC authentication may occur due to changes in authentik or the client ID/client secret. Update the client ID and client secret as needed.
|
2. **Symptom:** Recipe data is missing.
|
||||||
|
**Cause:** Data corruption during backup or restore process.
|
||||||
|
**Fix:** Perform a full backup and restore to ensure all data is intact.
|
||||||
|
3. **Symptom:** Authentication fails.
|
||||||
|
**Cause:** Incorrect credentials or authentication provider issues.
|
||||||
|
**Fix:** Verify that the authentication credentials are correct and the authentication provider is functioning correctly.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
### Changelog
|
||||||
## Changelog
|
|
||||||
|
|
||||||
| Date | Commit | Summary |
|
| Date | Commit | Summary |
|
||||||
|------|--------|---------|
|
|-|-|-|
|
||||||
| 2026-04-23 | 4205c70e | Initial documentation creation |
|
| 2026-04-23 | <inferred commits> |
|
||||||
| 2026-04-23 | 576b0d2b | Updated environment variables to include PUID, PGID, and TZ |
|
|
||||||
| 2026-04-23 | 93cbc1c6 | Added support for OIDC authentication with authentik |
|
|
||||||
| 2026-04-23 | 45ef1238 | Updated the recipe data API endpoint URL |
|
|
||||||
| 2026-04-23 | 9d01998f | Improved documentation formatting and structure |
|
|
||||||
| 2026-04-23 | 9d75346d | Added first run instructions for initializing the database |
|
|
||||||
| 2026-04-22 | ce657f97 | Updated OIDC configuration URL to point to auth.netgrimoire.com |
|
|
||||||
| 2026-04-22 | 85531b16 | Changed recipe data API endpoint URL to mealie:9000 |
|
|
||||||
| 2026-04-21 | a942ffb9 | Added support for mealie:9000 access to the Recipe Manager dashboard |
|
|
||||||
| 2026-04-21 | fdd16eff | Improved documentation formatting and structure |
|
|
||||||
|
|
||||||
Generated by Gremlin on 2026-04-23T15:28:56.774Z
|
---
|
||||||
|
### Notes
|
||||||
|
Generated by Gremlin on 2026-04-23T16:06:42.106Z
|
||||||
Source: swarm/mealie.yaml
|
Source: swarm/mealie.yaml
|
||||||
Review User Guide and Changelog sections
|
Review User Guide and Changelog sections
|
||||||
Loading…
Add table
Add a link
Reference in a new issue