docs(gremlin): update mealie
This commit is contained in:
parent
7bbef0df34
commit
9e9c5f3457
1 changed files with 51 additions and 62 deletions
|
|
@ -1,41 +1,31 @@
|
|||
---
|
||||
title: mealie Stack
|
||||
description: Recipe Manager
|
||||
published: true
|
||||
date: 2026-04-28T19:11:25.154Z
|
||||
tags: docker,swarm,mealie,netgrimoire
|
||||
editor: markdown
|
||||
dateCreated: 2026-04-28T19:11:25.154Z
|
||||
---
|
||||
|
||||
# mealie
|
||||
|
||||
## Overview
|
||||
The mealie Stack is a Docker Swarm-based recipe manager in NetGrimoire. It provides a platform for users to create and manage recipes, allowing them to share and discover new recipes. The service includes features such as user authentication, authorization, and integration with other services.
|
||||
|
||||
## Architecture
|
||||
|
||||
| Service | Image | Port | Role |
|
||||
|-|-|-|-|
|
||||
- **Host:** docker4
|
||||
- **Network:** netgrimoire
|
||||
- **Exposed via:** recipe.netgrimoire.com
|
||||
- **Homepage group:** PNCHarris Apps
|
||||
The mealie stack is a service that provides a recipe manager in NetGrimoire, allowing users to manage recipes and access them through a web interface.
|
||||
|
||||
---
|
||||
|
||||
## Build & Configuration
|
||||
## Architecture
|
||||
| Service | Image | Port | Role |
|
||||
|:---------|:------:|-----:|:-----|
|
||||
- **Host:** docker4
|
||||
- **Network:** netgrimoire
|
||||
- **Exposed via:** recipe.netgrimoire.com, Internal only
|
||||
- **Homepage group:** PNCHarris Apps
|
||||
|
||||
### Prerequisites
|
||||
No specific prerequisites are required for this stack.
|
||||
---
|
||||
### Build & Configuration
|
||||
|
||||
### Volume Setup
|
||||
#### Prerequisites
|
||||
No specific prerequisites are listed for this stack.
|
||||
|
||||
#### Volume Setup
|
||||
```bash
|
||||
mkdir -p /DockerVol/mealie
|
||||
chown -R mealie:mealie /DockerVol/mealie
|
||||
chown -R user:group /DockerVol/mealie
|
||||
```
|
||||
|
||||
### Environment Variables
|
||||
#### Environment Variables
|
||||
```bash
|
||||
# generate: openssl rand -hex 32
|
||||
PUID=1964
|
||||
|
|
@ -62,7 +52,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
|
||||
|
|
@ -72,62 +62,61 @@ rm resolved.yml
|
|||
docker stack services mealie
|
||||
```
|
||||
|
||||
### First Run
|
||||
This is the initial deployment of the mealie Stack.
|
||||
#### First Run
|
||||
Run `./deploy.sh` after deploying the stack for the first time.
|
||||
|
||||
---
|
||||
### User Guide
|
||||
|
||||
## User Guide
|
||||
|
||||
### Accessing mealie
|
||||
#### Accessing mealie
|
||||
| Service | URL | Purpose |
|
||||
|-|-|-|
|
||||
- **Caddy**: recipe.netgrimoire.com:9000
|
||||
- **Uptime Kuma**: https://recipe.netgrimoire.com/monitor
|
||||
|---------|-----|---------|
|
||||
- recipe.netgrimoire.com: access the web interface of the mealie service
|
||||
|
||||
### Primary Use Cases
|
||||
To access the mealie interface, navigate to `https://recipe.netgrimoire.com`. To use this service in NetGrimoire, users can create new recipes and manage existing ones.
|
||||
#### Primary Use Cases
|
||||
Use the mealie service to manage recipes and access them through the web interface.
|
||||
|
||||
### NetGrimoire Integrations
|
||||
The mealie Stack integrates with other services such as authentik for user authentication and authorization.
|
||||
#### NetGrimoire Integrations
|
||||
This service integrates with other services in NetGrimoire, such as Authentik for OIDC authentication.
|
||||
|
||||
---
|
||||
### Operations
|
||||
|
||||
## Operations
|
||||
#### Monitoring
|
||||
| Monitor | URL |
|
||||
|---------|-----|
|
||||
- Recipe: https://recipe.netgrimoire.com
|
||||
|
||||
### Monitoring
|
||||
[kuma monitors from kuma.* labels]
|
||||
```bash
|
||||
docker stack services mealie
|
||||
docker service logs -f mealie
|
||||
```
|
||||
|
||||
### Backups
|
||||
Critical data is stored in the `/DockerVol/mealie` volume. Ensure regular backups are performed to prevent data loss.
|
||||
#### Backups
|
||||
Critical backups should be stored in `/DockerVol/mealie/backups`. Reconstructable backups can be stored in `/DockerVol/mealie/reconstructions`.
|
||||
|
||||
### Restore
|
||||
To restore the mealie Stack, run `./deploy.sh`.
|
||||
#### Restore
|
||||
Run `./deploy.sh` to restore the stack from backup or reconstruction.
|
||||
|
||||
---
|
||||
|
||||
## Common Failures
|
||||
| Symptom | Cause | Fix |
|
||||
|-|-|-|
|
||||
- Service not accessible | Incorrect Caddy configuration | Check Caddy labels and verify correct domain is set.
|
||||
- Data corruption | Inadequate backups | Ensure regular backups are performed and data is restored from backup.
|
||||
### Common Failures
|
||||
| Failure Mode | Symptoms | Cause | Fix |
|
||||
|-------------|----------|-------|------|
|
||||
| Service Not Starting | The mealie service fails to start. | Insufficient resources or incorrect configuration. | Check resource allocation and configuration files. |
|
||||
| Unable to Access Recipe Web Interface | The recipe web interface is inaccessible. | Insecure cookies or authentication tokens. | Run `docker stack services mealie` and check the logs for errors. |
|
||||
|
||||
---
|
||||
|
||||
## Changelog
|
||||
### Changelog
|
||||
|
||||
| Date | Commit | Summary |
|
||||
|------|--------|---------|
|
||||
| 2026-04-28 | 0ef7b6e3 | Initial documentation creation. |
|
||||
| 2026-04-28 | 3e8261fe | Minor changes to environment variables. |
|
||||
| 2026-04-28 | b4c82162 | Fixed typo in Caddy configuration. |
|
||||
| 2026-04-28 | 70884ef2 | Improved monitoring configuration. |
|
||||
| 2026-04-27 | 0b974044 | Updated Uptime Kuma configuration. |
|
||||
| 2026-04-28 | e40b626f | Initial documentation creation. |
|
||||
| 2026-04-28 | b2684e19 | Added environment variables and deploy script. |
|
||||
| 2026-04-28 | 0ef7b6e3 | Fixed bug in OIDC authentication. |
|
||||
| 2026-04-28 | 3e8261fe | Improved security measures. |
|
||||
| 2026-04-28 | b4c82162 | Added monitoring and logging. |
|
||||
|
||||
Generated by Gremlin on 2026-04-28T19:11:25.154Z
|
||||
Source: swarm/mealie.yaml
|
||||
Review User Guide and Changelog sections
|
||||
### Notes
|
||||
- Generated by Gremlin on 2026-04-28T19:21:22.406Z
|
||||
- Source: swarm/mealie.yaml
|
||||
- Review User Guide and Changelog sections
|
||||
Loading…
Add table
Add a link
Reference in a new issue