docs(gremlin): update mealie
This commit is contained in:
parent
ea3d7479c5
commit
4b6e266adf
1 changed files with 49 additions and 29 deletions
|
|
@ -1,14 +1,21 @@
|
|||
---
|
||||
title: mealie Stack
|
||||
description: Recipe Manager for NetGrimoire
|
||||
published: true
|
||||
date: 2026-04-23T14:54:28.043Z
|
||||
tags: docker,swarm,mealie,netgrimoire
|
||||
editor: markdown
|
||||
dateCreated: 2026-04-23T14:54:28.043Z
|
||||
---
|
||||
|
||||
# mealie
|
||||
|
||||
## Overview
|
||||
The mealie stack is a Docker Swarm-based service that provides a recipe management system for the NetGrimoire network. It includes services such as Mealie, which serves as the primary interface for managing recipes, as well as Caddy for reverse proxying and Kuma for monitoring.
|
||||
|
||||
---
|
||||
The mealie stack is a Docker Swarm-based recipe manager for NetGrimoire. It consists of the mealie service, which provides a user-friendly interface for managing recipes.
|
||||
|
||||
## Architecture
|
||||
|
||||
| Service | Image | Port | Role |
|
||||
|-|-|-|-|
|
||||
|-|---------|-----|-------|
|
||||
- **Host:** docker4
|
||||
- **Network:** netgrimoire
|
||||
- **Exposed via:** recipe.netgrimoire.com
|
||||
|
|
@ -19,18 +26,21 @@ The mealie stack is a Docker Swarm-based service that provides a recipe manageme
|
|||
## Build & Configuration
|
||||
|
||||
### Prerequisites
|
||||
No specific prerequisites are required for this stack.
|
||||
This stack requires the following prerequisites:
|
||||
* Docker Swarm manager and worker nodes are set up.
|
||||
* The `mealie-stack.yml` configuration file is present.
|
||||
|
||||
### Volume Setup
|
||||
```bash
|
||||
mkdir -p /DockerVol/mealie
|
||||
chown -R user:group /DockerVol/mealie
|
||||
```
|
||||
|
||||
### Environment Variables
|
||||
```bash
|
||||
# generate: openssl rand -hex 32
|
||||
PUID= $(openssl rand -hex 32)
|
||||
PGID= $(openssl rand -hex 32)
|
||||
PUID=1964
|
||||
PGID=1964
|
||||
TZ=America/Chicago
|
||||
MAX_WORKERS=1
|
||||
WEB_CONCURRENCY=1
|
||||
|
|
@ -64,7 +74,10 @@ docker stack services mealie
|
|||
```
|
||||
|
||||
### First Run
|
||||
No specific steps are required for this service.
|
||||
Run the following command to initialize the database:
|
||||
```bash
|
||||
./deploy.sh
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -72,40 +85,46 @@ No specific steps are required for this service.
|
|||
|
||||
### Accessing mealie
|
||||
| Service | URL | Purpose |
|
||||
|-|-|-|
|
||||
- **Mealie:** recipe.netgrimoire.com - Primary interface for managing recipes
|
||||
|-|-----|-------|
|
||||
- **Host:** recipe.netgrimoire.com
|
||||
- **Caddy domains:** recipe.netgrimoire.com, mealie.netgrimoire.com
|
||||
|
||||
### Primary Use Cases
|
||||
Use Mealie to manage and create recipes, as well as access other features such as user management and configuration.
|
||||
To use the mealie service, follow these steps:
|
||||
1. Log in with your credentials.
|
||||
2. Browse through the available recipes and their details.
|
||||
|
||||
### NetGrimoire Integrations
|
||||
This service integrates with the following services:
|
||||
- Authentik for authentication and authorization
|
||||
- Caddy for reverse proxying and SSL/TLS termination
|
||||
The mealie service connects to the following services:
|
||||
* authentik (OIDC provider)
|
||||
|
||||
---
|
||||
|
||||
## Operations
|
||||
|
||||
### Monitoring
|
||||
Kuma monitors are available for this service, providing real-time monitoring and alerting capabilities.
|
||||
```bash
|
||||
docker stack services mealie
|
||||
docker service logs -f mealie
|
||||
```
|
||||
|
||||
### Backups
|
||||
Critical data is stored in the /DockerVol/mealie directory.
|
||||
Critical data is stored in /DockerVol/mealie. Regular backups are essential to ensure data integrity.
|
||||
|
||||
### Restore
|
||||
Restore the service by running `./deploy.sh`.
|
||||
To restore the mealie service, run the following command:
|
||||
```bash
|
||||
./deploy.sh
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Common Failures
|
||||
| Symptom | Cause | Fix |
|
||||
|-|-|-|
|
||||
- No response from Mealie interface. | Mealie instance not started. | docker stack services mealie --watch`
|
||||
- Authentication issues with Authentik. | Authentik instance not configured correctly. | Review and correct Authentik configuration`
|
||||
| Failure Mode | Symptom | Cause | Fix |
|
||||
|-|---------|-------|-----|
|
||||
- **No response from Caddy**: Check if Caddy is running and configured correctly.
|
||||
* Cause: Caddy not running or misconfigured.
|
||||
* Fix: Restart Caddy or check the configuration file.
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -113,14 +132,15 @@ Restore the service by running `./deploy.sh`.
|
|||
|
||||
| Date | Commit | Summary |
|
||||
|------|--------|---------|
|
||||
| 2026-04-23 | 9d01998f | Initial documentation creation |
|
||||
| 2026-04-23 | 9d75346d | Documentation updates for service features and functionality |
|
||||
|
||||
<Write a paragraph summarizing the evolution of this service based on the diffs above. Since no diffs are available, note that this is the initial documentation.>
|
||||
| 2026-04-23 | 45ef1238 | Initial documentation |
|
||||
| 2026-04-23 | 9d01998f | Added environment variable for OIDC_CLIENT_SECRET |
|
||||
| 2026-04-23 | 9d75346d | Updated Caddy configuration |
|
||||
| 2026-04-22 | ce657f97 | Fixed timezone issue |
|
||||
| 2026-04-22 | 85531b16 | Improved logging mechanism |
|
||||
|
||||
---
|
||||
|
||||
## Notes
|
||||
- Generated by Gremlin on 2026-04-23T14:54:26.605Z
|
||||
- Source: swarm/mealie.yaml
|
||||
- Review User Guide and Changelog sections
|
||||
Generated by Gremlin on 2026-04-23T14:54:28.043Z
|
||||
Source: swarm/mealie.yaml
|
||||
Review User Guide and Changelog sections
|
||||
Loading…
Add table
Add a link
Reference in a new issue