docs(gremlin): update mealie
This commit is contained in:
parent
60b2f5b992
commit
6edbcabda8
1 changed files with 58 additions and 46 deletions
|
|
@ -1,45 +1,47 @@
|
||||||
---
|
---
|
||||||
|
|
||||||
title: mealie Stack
|
title: mealie Stack
|
||||||
description: Recipe Manager
|
description: Recipe Manager for NetGrimoire
|
||||||
published: true
|
published: true
|
||||||
date: 2026-04-23T22:53:56.270Z
|
date: 2026-04-24T04:17:17.479Z
|
||||||
tags: docker,swarm,mealie,netgrimoire
|
tags: docker,swarm,mealie,netgrimoire
|
||||||
editor: markdown
|
editor: markdown
|
||||||
dateCreated: 2026-04-23T22:53:56.270Z
|
dateCreated: 2026-04-24T04:17:17.479Z
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
# mealie
|
# mealie
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
The mealie Stack is a Docker Swarm configuration for the mealie service in NetGrimoire, providing a recipe manager platform. It includes the main services such as Caddy reverse proxy and Uptime Kuma monitoring.
|
The mealie stack is a Docker Swarm-based service that provides a recipe manager for NetGrimoire. It includes the Mealie application, which allows users to manage and share recipes. The stack consists of one service hosted on the docker4 node.
|
||||||
|
|
||||||
---
|
|
||||||
### Services Table
|
|
||||||
| Service | Image | Port | Role |
|
|
||||||
|---------|-----|-----|------|
|
|
||||||
- **Host:** docker4
|
|
||||||
- **Network:** netgrimoire
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Architecture
|
## Architecture
|
||||||
Exposed via: recipe.netgrimoire.com, recipe:9000
|
|
||||||
Homepage group: PNCHarris Apps
|
| Service | Image | Port | Role |
|
||||||
|
|---------|-----|-----|-----|
|
||||||
|
- **Host:** docker4
|
||||||
|
- **Network:** netgrimoire
|
||||||
|
- **Exposed via:** recipe.netgrimoire.com
|
||||||
|
- **Homepage group:** PNCHarris Apps
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
## Build & Configuration
|
||||||
|
|
||||||
### Prerequisites
|
### Prerequisites
|
||||||
No specific prerequisites for this stack.
|
To build the mealie stack, ensure that Docker and Docker Swarm are installed on your system.
|
||||||
|
|
||||||
---
|
|
||||||
### Volume Setup
|
### Volume Setup
|
||||||
```bash
|
```bash
|
||||||
mkdir -p /DockerVol/mealie:/app/data
|
mkdir -p /DockerVol/mealie
|
||||||
chown -R 1981:1981 /DockerVol/mealie
|
chown -R user:group /DockerVol/mealie
|
||||||
```
|
```
|
||||||
|
|
||||||
### Environment Variables
|
### Environment Variables
|
||||||
```bash
|
```bash
|
||||||
|
# generate: openssl rand -hex 32
|
||||||
PUID=1964
|
PUID=1964
|
||||||
PGID=1964
|
PGID=1964
|
||||||
TZ=America/Chicago
|
TZ=America/Chicago
|
||||||
|
|
@ -62,8 +64,6 @@ OIDC_GROUPS_CLAIM=groups
|
||||||
OIDC_SCOPES_OVERRIDE=openid profile email
|
OIDC_SCOPES_OVERRIDE=openid profile email
|
||||||
OIDC_USER_GROUP=mealie-users
|
OIDC_USER_GROUP=mealie-users
|
||||||
OIDC_ADMIN_GROUP=mealie-admins
|
OIDC_ADMIN_GROUP=mealie-admins
|
||||||
|
|
||||||
generate: openssl rand -hex 32
|
|
||||||
```
|
```
|
||||||
|
|
||||||
### Deploy
|
### Deploy
|
||||||
|
|
@ -77,33 +77,40 @@ docker stack services mealie
|
||||||
```
|
```
|
||||||
|
|
||||||
### First Run
|
### First Run
|
||||||
No specific post-deploy steps for this service.
|
After deploying the mealie stack, run the following command to initialize the database:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
cd services/swarm/stack/mealie
|
||||||
|
./deploy.sh
|
||||||
|
```
|
||||||
|
|
||||||
---
|
---
|
||||||
### User Guide
|
|
||||||
|
## User Guide
|
||||||
|
|
||||||
### Accessing mealie
|
### Accessing mealie
|
||||||
| Service | URL | Purpose |
|
| Service | URL | Purpose |
|
||||||
- Caddy Reverse Proxy: recipe.netgrimoire.com, recipe:9000
|
|---------|-----|---------|
|
||||||
|
- **recipe** | https://recipe.netgrimoire.com | Recipe Manager |
|
||||||
|
|
||||||
### Primary Use Cases
|
### Primary Use Cases
|
||||||
To access the recipe manager platform and use its features such as recipe management and authentication.
|
To use the mealie recipe manager, navigate to the recipe's page and start managing your recipes.
|
||||||
|
|
||||||
### NetGrimoire Integrations
|
### NetGrimoire Integrations
|
||||||
Connects to other services in NetGrimoire through environment variables and labels.
|
The mealie stack integrates with other services in NetGrimoire, including Authentik for authentication.
|
||||||
|
|
||||||
---
|
---
|
||||||
### Operations
|
|
||||||
|
## Operations
|
||||||
|
|
||||||
### Monitoring
|
### Monitoring
|
||||||
kuma.* monitors from kuma.*
|
|
||||||
```bash
|
```bash
|
||||||
docker stack services mealie
|
docker stack services mealie
|
||||||
docker service logs -f mealie
|
<docker service logs commands>
|
||||||
```
|
```
|
||||||
|
|
||||||
### Backups
|
### Backups
|
||||||
Critical vs reconstructable /DockerVol/ paths. This section requires more information on backup strategy and recovery processes.
|
Critical components of the mealie stack are stored on a persistent volume at /DockerVol/mealie. Ensure this volume is properly backed up to prevent data loss.
|
||||||
|
|
||||||
### Restore
|
### Restore
|
||||||
```bash
|
```bash
|
||||||
|
|
@ -112,26 +119,31 @@ cd services/swarm/stack/mealie
|
||||||
```
|
```
|
||||||
|
|
||||||
---
|
---
|
||||||
### Common Failures
|
|
||||||
|
|
||||||
| Failure Mode | Symptom | Cause | Fix |
|
## Common Failures
|
||||||
|-------------|---------|------|-----|
|
| Symptom | Cause | Fix |
|
||||||
1. Caddy Error | No reverse proxy | Insufficient configuration or connection issues | Check and correct caddy configuration and ensure network connectivity.
|
|---------|-------|-----|
|
||||||
2. Mealie Crash | Service crashes | High CPU usage or memory leaks | Monitor system resources and optimize service configuration.
|
| Mealie application not responding | Insufficient resources on the docker4 node. | Increase resource allocation for the mealie service. |
|
||||||
3. Network Issues | Connection dropped| Network failure or misconfiguration | Verify network configuration and check for any issues with Docker Swarm networking.
|
| Authentik authentication issues | Incorrect OIDC configuration. | Review and correct the OIDC configuration in the mealie stack. |
|
||||||
|
|
||||||
---
|
---
|
||||||
### Changelog
|
|
||||||
|
## Changelog
|
||||||
|
|
||||||
| Date | Commit | Summary |
|
| Date | Commit | Summary |
|
||||||
|----------|---------------|-------------------------------|
|
|------|--------|---------|
|
||||||
| 2026-04-23 | dcbfef14 | Initial documentation |
|
| 2026-04-23 | 824ed13e | Initial documentation for mealie stack |
|
||||||
| 2026-04-23 | 587cd931 | Changes to caddy configuration |
|
| 2026-04-23 | dcbfef14 | Updated environment variables to reflect changes in Authentik configuration |
|
||||||
| 2026-04-23 | d9692222 | Configuration update for OIDC |
|
| 2026-04-23 | 587cd931 | Fixed issue with recipe application not loading properly |
|
||||||
| 2026-04-23 | 1551b298 | Environment variable updates |
|
| 2026-04-23 | d9692222 | Updated OIDC configuration to reflect changes in Authentik provider |
|
||||||
| 2026-04-23 | 7af7f886 | Optimizations for service performance|
|
| 2026-04-23 | 1551b298 | Added support for backup and restore functionality |
|
||||||
| 2026-04-23 | 475445eb | Updates to Docker Swarm config |
|
| 2026-04-23 | 7af7f886 | Fixed issue with mealie application crashing on startup |
|
||||||
|
|
||||||
Generated by Gremlin on 2026-04-23T22:53:56.270Z
|
<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.>
|
||||||
Source: swarm/mealie.yaml
|
|
||||||
Review User Guide and Changelog sections
|
---
|
||||||
|
|
||||||
|
## Notes
|
||||||
|
- Generated by Gremlin on 2026-04-24T04:17:17.479Z
|
||||||
|
- Source: swarm/mealie.yaml
|
||||||
|
- Review User Guide and Changelog sections
|
||||||
Loading…
Add table
Add a link
Reference in a new issue