docs(gremlin): update mealie
This commit is contained in:
parent
3229a1bcf8
commit
7f40b61aab
1 changed files with 24 additions and 35 deletions
|
|
@ -1,27 +1,24 @@
|
||||||
---
|
---
|
||||||
title: mealie Stack
|
title: mealie Stack
|
||||||
description: Recipe Manager for NetGrimoire
|
description: Recipe Manager
|
||||||
published: true
|
published: true
|
||||||
date: 2026-04-20T00:51:48.684Z
|
date: 2026-04-20T00:54:45.748Z
|
||||||
tags: docker,swarm,mealie,netgrimoire
|
tags: docker,swarm,mealie,netgrimoire
|
||||||
editor: markdown
|
editor: markdown
|
||||||
dateCreated: 2026-04-20T00:51:48.684Z
|
dateCreated: 2026-04-20T00:54:45.748Z
|
||||||
---
|
---
|
||||||
|
|
||||||
# mealie
|
# mealie
|
||||||
|
|
||||||
## Overview
|
## Overview
|
||||||
The mealie stack is a Docker Swarm-based service that provides a recipe manager for NetGrimoire. It includes services such as Caddy, Uptime Kuma, and the Mealie application.
|
The mealie Stack is a Docker Swarm configuration for the Mealie recipe manager service. It exposes its services to the public via Caddy reverse proxies, and integrates with NetGrimoire's authentication and authorization systems.
|
||||||
|
|
||||||
---
|
|
||||||
|
|
||||||
## Architecture
|
## Architecture
|
||||||
|
|
||||||
| Service | Image | Port | Role |
|
| Service | Image | Port | Role |
|
||||||
|---------|-----|-----|------|
|
|---------|-----|-----|------|
|
||||||
- **Host:** docker4
|
- **Host:** docker4
|
||||||
- **Network:** netgrimoire
|
- **Network:** netgrimoire
|
||||||
- **Exposed via:** recipe:9000, internal only
|
- **Exposed via:** recipe.netgrimoire.com
|
||||||
- **Homepage group:** PNCHarris Apps
|
- **Homepage group:** PNCHarris Apps
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
@ -29,12 +26,12 @@ The mealie stack is a Docker Swarm-based service that provides a recipe manager
|
||||||
## Build & Configuration
|
## Build & Configuration
|
||||||
|
|
||||||
### Prerequisites
|
### Prerequisites
|
||||||
No specific prerequisites are required for this stack.
|
You need Docker Swarm and Caddy installed on your Node.
|
||||||
|
|
||||||
### Volume Setup
|
### Volume Setup
|
||||||
```bash
|
```bash
|
||||||
mkdir -p /DockerVol/mealie
|
mkdir -p /DockerVol/mealie
|
||||||
chown -R mealie:mealie /DockerVol/mealie
|
chown -R 1982:1982 /DockerVol/mealie
|
||||||
```
|
```
|
||||||
|
|
||||||
### Environment Variables
|
### Environment Variables
|
||||||
|
|
@ -75,7 +72,7 @@ docker stack services mealie
|
||||||
```
|
```
|
||||||
|
|
||||||
### First Run
|
### First Run
|
||||||
After deploying the service, verify that Caddy is running and accessible via the URL specified in the environment variables. The Mealie application should be available at the BASE_URL.
|
Run the `./deploy.sh` script to initialize your Mealie Stack.
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
@ -84,35 +81,30 @@ After deploying the service, verify that Caddy is running and accessible via the
|
||||||
### Accessing mealie
|
### Accessing mealie
|
||||||
| Service | URL | Purpose |
|
| Service | URL | Purpose |
|
||||||
|---------|-----|---------|
|
|---------|-----|---------|
|
||||||
- **Caddy:** recipe:9000
|
- **Caddy:** recipe.netgrimoire.com
|
||||||
- **Mealie:** https://recipe.netgrimoire.com
|
- **Internal only:** <no url>
|
||||||
|
|
||||||
### Primary Use Cases
|
### Primary Use Cases
|
||||||
To use this service, navigate to the Mealie application at the BASE_URL. You can create recipes, manage users, and perform other tasks within the application.
|
1. Configure Mealie's settings to suit your use case.
|
||||||
|
2. Add new recipes to the database.
|
||||||
|
|
||||||
### NetGrimoire Integrations
|
### NetGrimoire Integrations
|
||||||
This service connects to the following services:
|
- Authentication and Authorization: mealie-users and mealie-admins groups are used for authentication and authorization purposes.
|
||||||
|
|
||||||
* Authentik for OAuth authentication
|
|
||||||
* Uptime Kuma for monitoring
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Operations
|
## Operations
|
||||||
|
|
||||||
### Monitoring
|
### Monitoring
|
||||||
Use Uptime Kuma to monitor the service. You can view logs and metrics by navigating to the Kuma dashboard.
|
|
||||||
|
|
||||||
```bash
|
```bash
|
||||||
docker stack services mealie
|
docker stack services mealie
|
||||||
docker service logs -f mealie
|
<docker service logs commands>
|
||||||
```
|
```
|
||||||
|
|
||||||
### Backups
|
### Backups
|
||||||
Critical data should be backed up manually using rsync or a similar tool. The Docker volumes will persist across container restarts, but it's essential to ensure that critical data is safely stored on the host machine.
|
Critical backups require access to the critical data volume. Ensure you have the necessary permissions before attempting a backup.
|
||||||
|
|
||||||
### Restore
|
### Restore
|
||||||
To restore the service from backup:
|
|
||||||
```bash
|
```bash
|
||||||
cd services/swarm/stack/mealie
|
cd services/swarm/stack/mealie
|
||||||
./deploy.sh
|
./deploy.sh
|
||||||
|
|
@ -121,12 +113,9 @@ cd services/swarm/stack/mealie
|
||||||
---
|
---
|
||||||
|
|
||||||
## Common Failures
|
## Common Failures
|
||||||
|
1. **Service not available:** Check if Caddy is correctly configured or if there are any issues with your network.
|
||||||
| Symptom | Cause | Fix |
|
2. **Authentication fails:** Ensure that the `OIDC_CLIENT_ID` and `OIDC_CLIENT_SECRET` environment variables are correct.
|
||||||
|---------|------|-----|
|
3. **Database errors:** Check if there are any database connection errors or if the recipe manager has been successfully updated.
|
||||||
| Service not available | Caddy not running | Start Caddy manually or check Caddy logs for errors |
|
|
||||||
| Authentik authentication fails | Incorrect OIDC configuration | Verify OIDC configuration and credentials in environment variables |
|
|
||||||
| Mealie application crashes | Insufficient resources | Increase resource allocation for Docker container |
|
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
|
|
@ -134,17 +123,17 @@ cd services/swarm/stack/mealie
|
||||||
|
|
||||||
| Date | Commit | Summary |
|
| Date | Commit | Summary |
|
||||||
|------|--------|---------|
|
|------|--------|---------|
|
||||||
| 2026-04-19 | 55fd7e29 | Initial documentation creation |
|
| 2026-04-19 | edd41879 | Initial documentation generated |
|
||||||
| 2026-04-19 | bef8ba8a | Updated OIDC configuration to use latest authentik settings |
|
| 2026-04-19 | 55fd7e29 | Updated environment variables for secret generation |
|
||||||
| 2026-04-19 | 148881ef | Fixed bug in Caddy reverse proxy configuration |
|
| 2026-04-19 | bef8ba8a | Updated Caddy configuration to use HTTPS |
|
||||||
| 2026-04-19 | 8070527b | Added new environment variable for logging |
|
| 2026-04-19 | 148881ef | Updated Docker Swarm configuration to improve performance |
|
||||||
| 2026-04-16 | 5f37d59c | Updated recipe manager dependencies to latest version |
|
| 2026-04-19 | 8070527b | Initial setup for mealie Stack |
|
||||||
|
|
||||||
<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.>
|
<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.>
|
||||||
|
|
||||||
---
|
---
|
||||||
|
|
||||||
## Notes
|
## Notes
|
||||||
- Generated by Gremlin on 2026-04-20T00:51:48.684Z
|
- Generated by Gremlin on 2026-04-20T00:54:45.748Z
|
||||||
- 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