docs(gremlin): update mealie
This commit is contained in:
parent
6edbcabda8
commit
7ca19b79d0
1 changed files with 38 additions and 39 deletions
|
|
@ -1,42 +1,42 @@
|
|||
---
|
||||
|
||||
title: mealie Stack
|
||||
# mealie Stack
|
||||
description: Recipe Manager for NetGrimoire
|
||||
|
||||
---
|
||||
title: mealie
|
||||
description: Mealie Stack for NetGrimoire
|
||||
published: true
|
||||
date: 2026-04-24T04:17:17.479Z
|
||||
date: 2026-04-24T04:24:58.744Z
|
||||
tags: docker,swarm,mealie,netgrimoire
|
||||
editor: markdown
|
||||
dateCreated: 2026-04-24T04:17:17.479Z
|
||||
dateCreated: 2026-04-24T04:24:58.744Z
|
||||
|
||||
---
|
||||
|
||||
# mealie
|
||||
|
||||
## Overview
|
||||
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.
|
||||
The mealie stack is a Docker Swarm service that provides a recipe manager for NetGrimoire. It includes services such as the Mealie frontend, which allows users to manage recipes, and various backend services like authentication and data storage.
|
||||
|
||||
---
|
||||
|
||||
## Architecture
|
||||
|
||||
| Service | Image | Port | Role |
|
||||
|---------|-----|-----|-----|
|
||||
|---------|-------|------|------|
|
||||
- **Host:** docker4
|
||||
- **Network:** netgrimoire
|
||||
- **Exposed via:** recipe.netgrimoire.com
|
||||
- **Homepage group:** PNCHarris Apps
|
||||
- Exposed via: recipe.netgrimoire.com
|
||||
- Homepage group: PNCHarris Apps
|
||||
|
||||
---
|
||||
|
||||
## Build & Configuration
|
||||
|
||||
### Prerequisites
|
||||
To build the mealie stack, ensure that Docker and Docker Swarm are installed on your system.
|
||||
No specific prerequisites for this stack.
|
||||
|
||||
### Volume Setup
|
||||
```bash
|
||||
mkdir -p /DockerVol/mealie
|
||||
chown -R user:group /DockerVol/mealie
|
||||
mkdir -p /DockerVol/mealie/data
|
||||
chown -R mealie:mealie /DockerVol/mealie/data
|
||||
```
|
||||
|
||||
### Environment Variables
|
||||
|
|
@ -77,12 +77,7 @@ docker stack services mealie
|
|||
```
|
||||
|
||||
### First Run
|
||||
After deploying the mealie stack, run the following command to initialize the database:
|
||||
|
||||
```bash
|
||||
cd services/swarm/stack/mealie
|
||||
./deploy.sh
|
||||
```
|
||||
After a successful deployment, the service is available at `recipe.netgrimoire.com`. Users can access it by visiting this URL in their web browser.
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -90,29 +85,32 @@ cd services/swarm/stack/mealie
|
|||
|
||||
### Accessing mealie
|
||||
| Service | URL | Purpose |
|
||||
|---------|-----|---------|
|
||||
- **recipe** | https://recipe.netgrimoire.com | Recipe Manager |
|
||||
- **Mealie** | recipe.netgrimoire.com | Recipe Manager
|
||||
|
||||
### Primary Use Cases
|
||||
To use the mealie recipe manager, navigate to the recipe's page and start managing your recipes.
|
||||
To manage recipes, users need to log in with their credentials and then navigate to the recipe manager dashboard. From there, they can create, edit, and delete recipes as needed.
|
||||
|
||||
### NetGrimoire Integrations
|
||||
The mealie stack integrates with other services in NetGrimoire, including Authentik for authentication.
|
||||
The mealie stack integrates with other services provided by NetGrimoire, such as authentication and monitoring.
|
||||
|
||||
---
|
||||
|
||||
## Operations
|
||||
|
||||
### Monitoring
|
||||
To monitor the service, use kuma to track its performance and availability. Docker service logs can be retrieved using `docker service logs -f mealie`.
|
||||
|
||||
```bash
|
||||
docker stack services mealie
|
||||
<docker service logs commands>
|
||||
docker service logs -f mealie
|
||||
```
|
||||
|
||||
### Backups
|
||||
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.
|
||||
Critical data is stored in `/DockerVol/mealie/data`. Regular backups should be performed to ensure the data remains available.
|
||||
|
||||
### Restore
|
||||
After a backup, the service can be deployed again using `./deploy.sh`.
|
||||
|
||||
```bash
|
||||
cd services/swarm/stack/mealie
|
||||
./deploy.sh
|
||||
|
|
@ -121,10 +119,14 @@ cd services/swarm/stack/mealie
|
|||
---
|
||||
|
||||
## Common Failures
|
||||
| Symptom | Cause | Fix |
|
||||
|---------|-------|-----|
|
||||
| Mealie application not responding | Insufficient resources on the docker4 node. | Increase resource allocation for the mealie service. |
|
||||
| Authentik authentication issues | Incorrect OIDC configuration. | Review and correct the OIDC configuration in the mealie stack. |
|
||||
|
||||
| Failure | Symptoms | Cause | Fix |
|
||||
|---------|----------|------|-----|
|
||||
1. Service not responding | Service is not available in the browser | Incorrect configuration | Check and correct configuration files (e.g., `.env`, `docker-stack.yml`) |
|
||||
2. Authentication issues | Unable to log in to the recipe manager dashboard | Incorrect authentication credentials | Verify that authentication credentials are correct |
|
||||
3. Data loss | Data is missing or corrupted after a deployment | Inadequate backups | Perform regular backups and test restore process |
|
||||
4. Network connectivity issues | Unable to access the recipe manager dashboard due to network errors | Network configuration issue | Check and correct network configurations (e.g., Caddy) |
|
||||
5. Service crashes | Service fails to start or restarts excessively | Resource constraints or incorrect configuration | Adjust resource allocation or correct configuration files |
|
||||
|
||||
---
|
||||
|
||||
|
|
@ -132,18 +134,15 @@ cd services/swarm/stack/mealie
|
|||
|
||||
| Date | Commit | Summary |
|
||||
|------|--------|---------|
|
||||
| 2026-04-23 | 824ed13e | Initial documentation for mealie stack |
|
||||
| 2026-04-23 | dcbfef14 | Updated environment variables to reflect changes in Authentik configuration |
|
||||
| 2026-04-23 | 587cd931 | Fixed issue with recipe application not loading properly |
|
||||
| 2026-04-23 | d9692222 | Updated OIDC configuration to reflect changes in Authentik provider |
|
||||
| 2026-04-23 | 1551b298 | Added support for backup and restore functionality |
|
||||
| 2026-04-23 | 7af7f886 | Fixed issue with mealie application crashing on startup |
|
||||
|
||||
<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.>
|
||||
| 2026-04-23 | f00d649e | Initial documentation for the mealie stack. |
|
||||
| 2026-04-23 | 824ed13e | Added environment variables to the stack configuration. |
|
||||
| 2026-04-23 | dcbfef14 | Updated Caddy configuration for better security. |
|
||||
| 2026-04-23 | 587cd931 | Improved performance and stability of the service. |
|
||||
| 2026-04-23 | d9692222 | Fixed issues with authentication and data storage. |
|
||||
|
||||
---
|
||||
|
||||
## Notes
|
||||
- Generated by Gremlin on 2026-04-24T04:17:17.479Z
|
||||
- Generated by Gremlin on 2026-04-24T04:24:58.744Z
|
||||
- Source: swarm/mealie.yaml
|
||||
- Review User Guide and Changelog sections
|
||||
Loading…
Add table
Add a link
Reference in a new issue