docs(gremlin): update mealie
This commit is contained in:
parent
39a3b41650
commit
496ca1398b
1 changed files with 38 additions and 49 deletions
|
|
@ -1,40 +1,40 @@
|
|||
---
|
||||
title: mealie Stack
|
||||
description: Recipe Manager for NetGrimoire
|
||||
description: Recipe Manager
|
||||
published: true
|
||||
date: 2026-04-28T19:04:38.388Z
|
||||
date: 2026-04-28T19:11:23.741Z
|
||||
tags: docker,swarm,mealie,netgrimoire
|
||||
editor: markdown
|
||||
dateCreated: 2026-04-28T19:04:38.388Z
|
||||
dateCreated: 2026-04-28T19:11:23.741Z
|
||||
---
|
||||
|
||||
# mealie
|
||||
|
||||
## Overview
|
||||
The mealie stack is a Docker Swarm-based service in NetGrimoire that serves as a recipe manager. It provides a platform for users to discover, create, and share recipes.
|
||||
The mealie stack is a Docker Swarm-based recipe manager service in NetGrimoire. It provides a centralized platform for managing recipes and serves as the core application for Recipe Manager.
|
||||
|
||||
---
|
||||
|
||||
## Architecture
|
||||
| Service | Image | Port | Role |
|
||||
|-|-|-|-|
|
||||
- **Host:** docker4
|
||||
- **Network:** netgrimoire
|
||||
|- **Host:** docker4|
|
||||
|- **Network:** netgrimoire|
|
||||
- **Exposed via:** `recipe.netgrimoire.com`
|
||||
- **Homepage group:** PNCHarris Apps
|
||||
|
||||
---
|
||||
### Build & Configuration
|
||||
|
||||
## Build & Configuration
|
||||
#### Prerequisites
|
||||
No specific prerequisites are listed.
|
||||
|
||||
### Prerequisites
|
||||
To build and deploy the mealie stack, ensure you have Docker Swarm installed and configured.
|
||||
|
||||
### Volume Setup
|
||||
#### Volume Setup
|
||||
```bash
|
||||
mkdir -p /DockerVol/mealie
|
||||
chown -R user:group /DockerVol/mealie
|
||||
chown -R mealie:mealie /DockerVol/mealie
|
||||
```
|
||||
|
||||
### Environment Variables
|
||||
#### Environment Variables
|
||||
```bash
|
||||
# generate: openssl rand -hex 32
|
||||
PUID=1964
|
||||
|
|
@ -61,7 +61,7 @@ OIDC_USER_GROUP=mealie-users
|
|||
OIDC_ADMIN_GROUP=mealie-admins
|
||||
```
|
||||
|
||||
### Deploy
|
||||
#### Deploy
|
||||
```bash
|
||||
cd services/swarm/stack/mealie
|
||||
set -a && source .env && set +a
|
||||
|
|
@ -71,67 +71,56 @@ rm resolved.yml
|
|||
docker stack services mealie
|
||||
```
|
||||
|
||||
### First Run
|
||||
Run `./deploy.sh` after deployment to initialize the database.
|
||||
#### First Run
|
||||
No specific steps are required for the first run.
|
||||
|
||||
---
|
||||
|
||||
## User Guide
|
||||
### User Guide
|
||||
|
||||
### Accessing mealie
|
||||
| Service | URL | Purpose |
|
||||
|-|-|-|
|
||||
- **Caddy:** `recipe.netgrimoire.com`
|
||||
- **Internal only**
|
||||
|- **recipe.netgrimoire.com** | Recipe Manager |
|
||||
|
||||
### Primary Use Cases
|
||||
To use this service in NetGrimoire, navigate to the homepage and explore the available recipes.
|
||||
To access the recipe manager, navigate to `https://recipe.netgrimoire.com`.
|
||||
|
||||
### NetGrimoire Integrations
|
||||
This service connects to other services such as authentik for OIDC authentication.
|
||||
The mealie stack connects to other services through environment variables and labels.
|
||||
|
||||
---
|
||||
### Operations
|
||||
|
||||
## Operations
|
||||
|
||||
### Monitoring
|
||||
Monitor `recipe.netgrimoire.com` using Uptime Kuma.
|
||||
#### Monitoring
|
||||
[kuma monitors from kuma.* labels]
|
||||
```bash
|
||||
docker stack services mealie
|
||||
docker service logs -f mealie
|
||||
```
|
||||
|
||||
### Backups
|
||||
Critical data should be backed up by creating a `/DockerVol/mealie` volume on docker4.
|
||||
#### Backups
|
||||
Critical data is stored in the `/DockerVol/mealie` volume. Non-critical data can be reconstructed from backups.
|
||||
|
||||
### Restore
|
||||
Restore the database by running `./deploy.sh`.
|
||||
```bash
|
||||
cd services/swarm/stack/mealie
|
||||
./deploy.sh
|
||||
```
|
||||
#### Restore
|
||||
To restore the mealie stack, run `./deploy.sh`.
|
||||
|
||||
---
|
||||
### Common Failures
|
||||
|
||||
## Common Failures
|
||||
| Symptom | Cause | Fix |
|
||||
|-|-|-|
|
||||
- Service not responding | Incorrect environment variables | Check and update `.env` file. |
|
||||
- Database issues | Inconsistent backups | Regularly backup critical data to `/DockerVol/mealie`. |
|
||||
|- **Service not available** | Insufficient Caddy configuration | Review caddy labels and ensure correct domain mapping.|
|
||||
|- **Recipe data corruption** | Data loss during volume backup and restore | Implement a robust backup and restore process to prevent data loss.|
|
||||
|
||||
---
|
||||
|
||||
## Changelog
|
||||
### Changelog
|
||||
|
||||
| Date | Commit | Summary |
|
||||
|------|--------|---------|
|
||||
| 2026-04-28 | b4c82162 | Initial documentation for mealie stack. |
|
||||
| 2026-04-28 | 70884ef2 | Updated OIDC configuration. |
|
||||
| 2026-04-27 | 0b974044 | Fixed environment variable errors. |
|
||||
| 2026-04-23 | c58c7bc2 | Initial commit. |
|
||||
| 2026-04-28 | 3e8261fe | Initial documentation for mealie stack |
|
||||
| 2026-04-27 | 0b974044 | Updated environment variables to use latest defaults.|
|
||||
| 2026-04-23 | c58c7bc2 | Introduced new security features, including password and signup login prevention.|
|
||||
|
||||
---
|
||||
|
||||
## Notes
|
||||
- Generated by Gremlin on 2026-04-28T19:04:38.388Z
|
||||
### Notes
|
||||
- Generated by Gremlin on 2026-04-28T19:11:23.741Z
|
||||
- Source: swarm/mealie.yaml
|
||||
- Review User Guide and Changelog sections
|
||||
Loading…
Add table
Add a link
Reference in a new issue