mirror of
https://github.com/rtomik/helm-charts.git
synced 2026-07-16 16:25:16 +00:00
version bump norish
This commit is contained in:
@ -1,273 +1,41 @@
|
||||
# Mealie Helm Chart
|
||||
|
||||
A Helm chart for deploying Mealie recipe management and meal planning application on Kubernetes.
|
||||
A Helm chart for deploying [Mealie](https://github.com/mealie-recipes/mealie), a recipe management and meal planning application, on Kubernetes.
|
||||
|
||||
## Introduction
|
||||
|
||||
This chart deploys [Mealie](https://github.com/mealie-recipes/mealie) on a Kubernetes cluster using the Helm package manager. Mealie is a self-hosted recipe manager and meal planner with a RestAPI backend and a reactive frontend application built in Vue for a pleasant user experience for the whole family.
|
||||
This chart deploys Mealie on a Kubernetes cluster using the Helm package manager. Mealie is a self-hosted recipe manager with a reactive frontend and RestAPI backend, supporting PostgreSQL or SQLite databases, LDAP/OIDC authentication, and OpenAI integration.
|
||||
|
||||
Source code can be found here:
|
||||
- https://github.com/rtomik/helm-charts/tree/main/charts/mealie
|
||||
Source code: https://github.com/rtomik/helm-charts/tree/main/charts/mealie
|
||||
|
||||
## Prerequisites
|
||||
|
||||
- Kubernetes 1.19+
|
||||
- Helm 3.0+
|
||||
- PV provisioner support in the underlying infrastructure (if persistence is needed)
|
||||
- External Postgresql DB like https://cloudnative-pg.io/
|
||||
- External PostgreSQL database (recommended, e.g. [CloudNativePG](https://cloudnative-pg.io/))
|
||||
- PV provisioner support (if persistence is needed)
|
||||
|
||||
## Installing the Chart
|
||||
|
||||
To install the chart with the release name `mealie`:
|
||||
|
||||
```bash
|
||||
$ helm repo add mealie-chart https://rtomik.github.io/helm-charts
|
||||
$ helm install mealie mealie-chart/mealie
|
||||
helm repo add rtomik https://rtomik.github.io/helm-charts
|
||||
helm install mealie rtomik/mealie
|
||||
```
|
||||
|
||||
> **Tip**: List all releases using `helm list`
|
||||
|
||||
## Uninstalling the Chart
|
||||
|
||||
To uninstall/delete the `mealie` deployment:
|
||||
|
||||
```bash
|
||||
$ helm uninstall mealie
|
||||
helm uninstall mealie
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
### Global parameters
|
||||
|
||||
| Name | Description | Value |
|
||||
|------------------------|------------------------------------------------|-------|
|
||||
| `nameOverride` | String to partially override the release name | `""` |
|
||||
| `fullnameOverride` | String to fully override the release name | `""` |
|
||||
|
||||
### Image parameters
|
||||
|
||||
| Name | Description | Value |
|
||||
|-------------------------|-----------------------------------|-----------------------------------|
|
||||
| `image.repository` | Mealie image repository | `ghcr.io/mealie-recipes/mealie` |
|
||||
| `image.tag` | Mealie image tag | `v3.1.1` |
|
||||
| `image.pullPolicy` | Mealie image pull policy | `IfNotPresent` |
|
||||
|
||||
### Deployment parameters
|
||||
|
||||
| Name | Description | Value |
|
||||
|--------------------------------------|-----------------------------------------------|-----------|
|
||||
| `replicaCount` | Number of Mealie replicas | `1` |
|
||||
| `revisionHistoryLimit` | Number of revisions to retain for rollback | `3` |
|
||||
| `podSecurityContext.runAsNonRoot` | Run containers as non-root user | `false` |
|
||||
| `podSecurityContext.runAsUser` | User ID for the container | `911` |
|
||||
| `podSecurityContext.fsGroup` | Group ID for the container filesystem | `911` |
|
||||
| `containerSecurityContext` | Security context for the container | See values.yaml |
|
||||
| `nodeSelector` | Node labels for pod assignment | `{}` |
|
||||
| `tolerations` | Tolerations for pod assignment | `[]` |
|
||||
| `affinity` | Affinity for pod assignment | `{}` |
|
||||
|
||||
### Service parameters
|
||||
|
||||
| Name | Description | Value |
|
||||
|----------------|-----------------------|-------------|
|
||||
| `service.type` | Kubernetes Service type | `ClusterIP` |
|
||||
| `service.port` | Service HTTP port | `9000` |
|
||||
|
||||
### Ingress parameters
|
||||
|
||||
| Name | Description | Value |
|
||||
|-------------------------|-------------------------------------------|-----------------|
|
||||
| `ingress.enabled` | Enable ingress record generation | `false` |
|
||||
| `ingress.className` | IngressClass name | `""` |
|
||||
| `ingress.annotations` | Additional annotations for the Ingress | See values.yaml |
|
||||
| `ingress.hosts` | Array of host and path objects | See values.yaml |
|
||||
| `ingress.tls` | TLS configuration | See values.yaml |
|
||||
|
||||
### Persistence parameters
|
||||
|
||||
| Name | Description | Value |
|
||||
|-------------------------------|----------------------------------|-----------------|
|
||||
| `persistence.enabled` | Enable persistence using PVC | `true` |
|
||||
| `persistence.storageClass` | PVC Storage Class | `""` |
|
||||
| `persistence.accessMode` | PVC Access Mode | `ReadWriteOnce` |
|
||||
| `persistence.size` | PVC Size | `5Gi` |
|
||||
| `persistence.annotations` | Annotations for PVC | `{}` |
|
||||
|
||||
### Environment variables
|
||||
|
||||
| Name | Description | Value |
|
||||
|---------------------------------------|-----------------------------------------------|-----------------|
|
||||
| `env.PUID` | UserID permissions between host OS and container | `911` |
|
||||
| `env.PGID` | GroupID permissions between host OS and container | `911` |
|
||||
| `env.DEFAULT_GROUP` | The default group for users | `Home` |
|
||||
| `env.DEFAULT_HOUSEHOLD` | The default household for users in each group | `Family` |
|
||||
| `env.BASE_URL` | Used for Notifications | `http://localhost:9000` |
|
||||
| `env.TOKEN_TIME` | The time in hours that a login/auth token is valid | `48` |
|
||||
| `env.API_PORT` | The port exposed by backend API | `9000` |
|
||||
| `env.API_DOCS` | Turns on/off access to the API documentation | `true` |
|
||||
| `env.TZ` | Must be set to get correct date/time on the server | `UTC` |
|
||||
| `env.ALLOW_SIGNUP` | Allow user sign-up without token | `false` |
|
||||
| `env.ALLOW_PASSWORD_LOGIN` | Whether or not to display username+password input fields | `true` |
|
||||
| `env.LOG_LEVEL` | Logging level | `info` |
|
||||
| `env.DAILY_SCHEDULE_TIME` | Time to run daily server tasks (HH:MM) | `23:45` |
|
||||
|
||||
### PostgreSQL configuration
|
||||
|
||||
| Name | Description | Value |
|
||||
|----------------------------------------|-----------------------------------------------|-----------|
|
||||
| `postgresql.enabled` | Enable PostgreSQL support | `false` |
|
||||
| `postgresql.external.enabled` | Use external PostgreSQL database | `false` |
|
||||
| `postgresql.external.host` | PostgreSQL host | `""` |
|
||||
| `postgresql.external.port` | PostgreSQL port | `5432` |
|
||||
| `postgresql.external.database` | PostgreSQL database name | `mealie` |
|
||||
| `postgresql.external.user` | PostgreSQL username | `mealie` |
|
||||
| `postgresql.external.password` | PostgreSQL password | `""` |
|
||||
| `postgresql.external.existingSecret` | Name of existing secret with PostgreSQL credentials | `""` |
|
||||
| `postgresql.external.userKey` | Key in the secret for username | `username` |
|
||||
| `postgresql.external.passwordKey` | Key in the secret for password | `password` |
|
||||
|
||||
### Email (SMTP) configuration
|
||||
|
||||
| Name | Description | Value |
|
||||
|--------------------------|--------------------------------------|-----------|
|
||||
| `email.enabled` | Enable SMTP email support | `false` |
|
||||
| `email.host` | SMTP host | `""` |
|
||||
| `email.port` | SMTP port | `587` |
|
||||
| `email.fromName` | From name for emails | `Mealie` |
|
||||
| `email.authStrategy` | SMTP auth strategy (TLS, SSL, NONE) | `TLS` |
|
||||
| `email.fromEmail` | From email address | `""` |
|
||||
| `email.user` | SMTP username | `""` |
|
||||
| `email.password` | SMTP password | `""` |
|
||||
| `email.existingSecret` | Name of existing secret with SMTP credentials | `""` |
|
||||
| `email.userKey` | Key in the secret for SMTP username | `smtp-user` |
|
||||
| `email.passwordKey` | Key in the secret for SMTP password | `smtp-password` |
|
||||
|
||||
### LDAP Authentication
|
||||
|
||||
| Name | Description | Value |
|
||||
|--------------------------|--------------------------------------|-----------|
|
||||
| `ldap.enabled` | Enable LDAP authentication | `false` |
|
||||
| `ldap.serverUrl` | LDAP server URL | `""` |
|
||||
| `ldap.tlsInsecure` | Do not verify server certificate | `false` |
|
||||
| `ldap.tlsCaCertFile` | Path to CA certificate file | `""` |
|
||||
| `ldap.enableStartTls` | Use STARTTLS to connect to server | `false` |
|
||||
| `ldap.baseDn` | Starting point for user authentication | `""` |
|
||||
| `ldap.queryBind` | Optional bind user for LDAP searches | `""` |
|
||||
| `ldap.queryPassword` | Password for the bind user | `""` |
|
||||
| `ldap.userFilter` | LDAP filter to narrow down eligible users | `""` |
|
||||
| `ldap.adminFilter` | LDAP filter for admin users | `""` |
|
||||
| `ldap.idAttribute` | LDAP attribute for user ID | `uid` |
|
||||
| `ldap.nameAttribute` | LDAP attribute for user name | `name` |
|
||||
| `ldap.mailAttribute` | LDAP attribute for user email | `mail` |
|
||||
|
||||
### OpenID Connect (OIDC)
|
||||
|
||||
| Name | Description | Value |
|
||||
|------------------------------|------------------------------------------|-----------|
|
||||
| `oidc.enabled` | Enable OIDC authentication | `false` |
|
||||
| `oidc.signupEnabled` | Allow new users via OIDC | `true` |
|
||||
| `oidc.configurationUrl` | URL to OIDC configuration | `""` |
|
||||
| `oidc.clientId` | OIDC client ID | `""` |
|
||||
| `oidc.clientSecret` | OIDC client secret | `""` |
|
||||
| `oidc.userGroup` | Required OIDC user group | `""` |
|
||||
| `oidc.adminGroup` | OIDC admin group | `""` |
|
||||
| `oidc.autoRedirect` | Bypass login page and redirect to IdP | `false` |
|
||||
| `oidc.providerName` | Provider name shown in login button | `OAuth` |
|
||||
| `oidc.rememberMe` | Extend session as if "Remember Me" was checked | `false` |
|
||||
| `oidc.signingAlgorithm` | Algorithm used to sign the id token | `RS256` |
|
||||
| `oidc.userClaim` | Claim to look up existing user by | `email` |
|
||||
| `oidc.nameClaim` | Claim for user's full name | `name` |
|
||||
| `oidc.groupsClaim` | Claim for user groups | `groups` |
|
||||
|
||||
### OpenAI Integration
|
||||
|
||||
| Name | Description | Value |
|
||||
|------------------------------------|------------------------------------------|-----------|
|
||||
| `openai.enabled` | Enable OpenAI integration | `false` |
|
||||
| `openai.baseUrl` | Base URL for OpenAI API | `""` |
|
||||
| `openai.apiKey` | OpenAI API key | `""` |
|
||||
| `openai.model` | OpenAI model to use | `gpt-4o` |
|
||||
| `openai.customHeaders` | Custom HTTP headers for OpenAI requests | `""` |
|
||||
| `openai.customParams` | Custom HTTP query params for OpenAI requests | `""` |
|
||||
| `openai.enableImageServices` | Enable OpenAI image services | `true` |
|
||||
| `openai.workers` | Number of OpenAI workers per request | `2` |
|
||||
| `openai.sendDatabaseData` | Send Mealie data to OpenAI to improve accuracy | `true` |
|
||||
| `openai.requestTimeout` | Timeout for OpenAI requests in seconds | `60` |
|
||||
|
||||
### TLS Configuration
|
||||
|
||||
| Name | Description | Value |
|
||||
|--------------------------|--------------------------------------|-----------|
|
||||
| `tls.enabled` | Enable TLS configuration | `false` |
|
||||
| `tls.certificatePath` | Path to TLS certificate file | `""` |
|
||||
| `tls.privateKeyPath` | Path to TLS private key file | `""` |
|
||||
| `tls.existingSecret` | Name of existing secret with TLS certificates | `""` |
|
||||
| `tls.certificateKey` | Key in the secret for TLS certificate | `tls.crt` |
|
||||
| `tls.privateKeyKey` | Key in the secret for TLS private key | `tls.key` |
|
||||
|
||||
### Theme Configuration
|
||||
|
||||
| Name | Description | Value |
|
||||
|-------------------------------|--------------------------------|-----------|
|
||||
| `theme.light.primary` | Light theme primary color | `#E58325` |
|
||||
| `theme.light.accent` | Light theme accent color | `#007A99` |
|
||||
| `theme.light.secondary` | Light theme secondary color | `#973542` |
|
||||
| `theme.light.success` | Light theme success color | `#43A047` |
|
||||
| `theme.light.info` | Light theme info color | `#1976D2` |
|
||||
| `theme.light.warning` | Light theme warning color | `#FF6D00` |
|
||||
| `theme.light.error` | Light theme error color | `#EF5350` |
|
||||
| `theme.dark.primary` | Dark theme primary color | `#E58325` |
|
||||
| `theme.dark.accent` | Dark theme accent color | `#007A99` |
|
||||
| `theme.dark.secondary` | Dark theme secondary color | `#973542` |
|
||||
| `theme.dark.success` | Dark theme success color | `#43A047` |
|
||||
| `theme.dark.info` | Dark theme info color | `#1976D2` |
|
||||
| `theme.dark.warning` | Dark theme warning color | `#FF6D00` |
|
||||
| `theme.dark.error` | Dark theme error color | `#EF5350` |
|
||||
|
||||
### Resource Configuration
|
||||
|
||||
| Name | Description | Value |
|
||||
|-------------|--------------------------------------|-------|
|
||||
| `resources` | Resource limits and requests | `{}` |
|
||||
|
||||
### Health Checks
|
||||
|
||||
| Name | Description | Value |
|
||||
|-------------------------------------------|------------------------------------------|-------|
|
||||
| `probes.liveness.enabled` | Enable liveness probe | `true` |
|
||||
| `probes.liveness.initialDelaySeconds` | Initial delay for liveness probe | `60` |
|
||||
| `probes.liveness.periodSeconds` | Period for liveness probe | `30` |
|
||||
| `probes.liveness.timeoutSeconds` | Timeout for liveness probe | `10` |
|
||||
| `probes.liveness.failureThreshold` | Failure threshold for liveness probe | `3` |
|
||||
| `probes.liveness.successThreshold` | Success threshold for liveness probe | `1` |
|
||||
| `probes.liveness.path` | Path for liveness probe | `/` |
|
||||
| `probes.readiness.enabled` | Enable readiness probe | `true` |
|
||||
| `probes.readiness.initialDelaySeconds` | Initial delay for readiness probe | `30` |
|
||||
| `probes.readiness.periodSeconds` | Period for readiness probe | `10` |
|
||||
| `probes.readiness.timeoutSeconds` | Timeout for readiness probe | `5` |
|
||||
| `probes.readiness.failureThreshold` | Failure threshold for readiness probe | `3` |
|
||||
| `probes.readiness.successThreshold` | Success threshold for readiness probe | `1` |
|
||||
| `probes.readiness.path` | Path for readiness probe | `/` |
|
||||
|
||||
### Autoscaling
|
||||
|
||||
| Name | Description | Value |
|
||||
|---------------------------------------------|------------------------------------------|---------|
|
||||
| `autoscaling.enabled` | Enable horizontal pod autoscaling | `false` |
|
||||
| `autoscaling.minReplicas` | Minimum number of replicas | `1` |
|
||||
| `autoscaling.maxReplicas` | Maximum number of replicas | `3` |
|
||||
| `autoscaling.targetCPUUtilizationPercentage`| Target CPU utilization percentage | `80` |
|
||||
| `autoscaling.targetMemoryUtilizationPercentage`| Target memory utilization percentage | `80` |
|
||||
|
||||
## Configuration Examples
|
||||
|
||||
### Basic Installation with Persistence
|
||||
### Minimal Installation
|
||||
|
||||
```yaml
|
||||
persistence:
|
||||
enabled: true
|
||||
size: 10Gi
|
||||
storageClass: "fast-ssd"
|
||||
|
||||
ingress:
|
||||
enabled: true
|
||||
@ -282,7 +50,7 @@ ingress:
|
||||
secretName: mealie-tls
|
||||
```
|
||||
|
||||
### PostgreSQL Database Configuration
|
||||
### PostgreSQL Configuration
|
||||
|
||||
```yaml
|
||||
postgresql:
|
||||
@ -300,7 +68,7 @@ env:
|
||||
DB_ENGINE: "postgres"
|
||||
```
|
||||
|
||||
### OIDC Authentication Setup
|
||||
### OIDC Authentication
|
||||
|
||||
```yaml
|
||||
oidc:
|
||||
@ -326,27 +94,273 @@ openai:
|
||||
enableImageServices: true
|
||||
```
|
||||
|
||||
## Security Considerations
|
||||
### LDAP Authentication
|
||||
|
||||
For production deployments, it's recommended to:
|
||||
```yaml
|
||||
ldap:
|
||||
enabled: true
|
||||
serverUrl: "ldap://ldap.example.com"
|
||||
baseDn: "ou=users,dc=example,dc=com"
|
||||
queryBind: "cn=admin,dc=example,dc=com"
|
||||
queryPassword: "bind-password"
|
||||
userFilter: "(objectClass=inetOrgPerson)"
|
||||
idAttribute: "uid"
|
||||
nameAttribute: "name"
|
||||
mailAttribute: "mail"
|
||||
```
|
||||
|
||||
1. Use external secrets for sensitive information
|
||||
2. Enable TLS/SSL for all communications
|
||||
3. Configure proper RBAC and network policies
|
||||
4. Use a dedicated database with proper access controls
|
||||
5. Enable authentication (LDAP/OIDC) and disable public signup
|
||||
### Email Configuration
|
||||
|
||||
```yaml
|
||||
email:
|
||||
enabled: true
|
||||
host: "smtp.example.com"
|
||||
port: 587
|
||||
fromName: "Mealie"
|
||||
fromEmail: "mealie@example.com"
|
||||
authStrategy: "TLS"
|
||||
existingSecret: "mealie-smtp-secret"
|
||||
userKey: "smtp-user"
|
||||
passwordKey: "smtp-password"
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
### Global Parameters
|
||||
|
||||
| Name | Description | Default |
|
||||
|------|-------------|---------|
|
||||
| `nameOverride` | Override the release name | `""` |
|
||||
| `fullnameOverride` | Fully override the release name | `""` |
|
||||
|
||||
### Image Parameters
|
||||
|
||||
| Name | Description | Default |
|
||||
|------|-------------|---------|
|
||||
| `image.repository` | Mealie image repository | `ghcr.io/mealie-recipes/mealie` |
|
||||
| `image.tag` | Image tag | `v3.2.1` |
|
||||
| `image.pullPolicy` | Image pull policy | `IfNotPresent` |
|
||||
|
||||
### Deployment Parameters
|
||||
|
||||
| Name | Description | Default |
|
||||
|------|-------------|---------|
|
||||
| `replicaCount` | Number of replicas | `1` |
|
||||
| `revisionHistoryLimit` | Revisions to retain | `3` |
|
||||
| `podSecurityContext.runAsNonRoot` | Run as non-root | `false` |
|
||||
| `podSecurityContext.runAsUser` | User ID | `911` |
|
||||
| `podSecurityContext.fsGroup` | Filesystem group ID | `911` |
|
||||
| `nodeSelector` | Node selector | `{}` |
|
||||
| `tolerations` | Tolerations | `[]` |
|
||||
| `affinity` | Affinity rules | `{}` |
|
||||
|
||||
### Service Parameters
|
||||
|
||||
| Name | Description | Default |
|
||||
|------|-------------|---------|
|
||||
| `service.type` | Service type | `ClusterIP` |
|
||||
| `service.port` | Service port | `9000` |
|
||||
|
||||
### Ingress Parameters
|
||||
|
||||
| Name | Description | Default |
|
||||
|------|-------------|---------|
|
||||
| `ingress.enabled` | Enable ingress | `false` |
|
||||
| `ingress.className` | Ingress class name | `""` |
|
||||
| `ingress.annotations` | Ingress annotations | See values.yaml |
|
||||
| `ingress.hosts` | Ingress hosts | See values.yaml |
|
||||
| `ingress.tls` | TLS configuration | See values.yaml |
|
||||
|
||||
### Persistence Parameters
|
||||
|
||||
| Name | Description | Default |
|
||||
|------|-------------|---------|
|
||||
| `persistence.enabled` | Enable persistence | `false` |
|
||||
| `persistence.storageClass` | Storage class | `""` |
|
||||
| `persistence.accessMode` | Access mode | `ReadWriteOnce` |
|
||||
| `persistence.size` | PVC size | `5Gi` |
|
||||
| `persistence.annotations` | PVC annotations | `{}` |
|
||||
|
||||
### Environment Variables
|
||||
|
||||
| Name | Description | Default |
|
||||
|------|-------------|---------|
|
||||
| `env.PUID` | User ID for host permissions | `911` |
|
||||
| `env.PGID` | Group ID for host permissions | `911` |
|
||||
| `env.DEFAULT_GROUP` | Default group for users | `Home` |
|
||||
| `env.DEFAULT_HOUSEHOLD` | Default household | `Family` |
|
||||
| `env.BASE_URL` | Base URL for notifications | `http://localhost:9000` |
|
||||
| `env.TOKEN_TIME` | Login token validity (hours) | `48` |
|
||||
| `env.API_PORT` | Backend API port | `9000` |
|
||||
| `env.API_DOCS` | Enable API documentation | `true` |
|
||||
| `env.TZ` | Timezone | `UTC` |
|
||||
| `env.ALLOW_SIGNUP` | Allow user sign-up | `false` |
|
||||
| `env.ALLOW_PASSWORD_LOGIN` | Allow password login | `true` |
|
||||
| `env.LOG_LEVEL` | Log level | `info` |
|
||||
| `env.DAILY_SCHEDULE_TIME` | Daily task schedule (HH:MM) | `23:45` |
|
||||
| `env.DB_ENGINE` | Database engine (`postgres` or `sqlite`) | `postgres` |
|
||||
| `extraEnv` | Additional environment variables | `[]` |
|
||||
|
||||
### PostgreSQL Configuration
|
||||
|
||||
| Name | Description | Default |
|
||||
|------|-------------|---------|
|
||||
| `postgresql.enabled` | Enable PostgreSQL | `false` |
|
||||
| `postgresql.external.enabled` | Use external PostgreSQL | `false` |
|
||||
| `postgresql.external.host` | PostgreSQL host | `""` |
|
||||
| `postgresql.external.port` | PostgreSQL port | `5432` |
|
||||
| `postgresql.external.database` | Database name | `mealie` |
|
||||
| `postgresql.external.user` | Username | `mealie` |
|
||||
| `postgresql.external.password` | Password | `""` |
|
||||
| `postgresql.external.existingSecret` | Existing secret name | `""` |
|
||||
| `postgresql.external.userKey` | Key for username in secret | `username` |
|
||||
| `postgresql.external.passwordKey` | Key for password in secret | `password` |
|
||||
|
||||
### LDAP Authentication
|
||||
|
||||
| Name | Description | Default |
|
||||
|------|-------------|---------|
|
||||
| `ldap.enabled` | Enable LDAP | `false` |
|
||||
| `ldap.serverUrl` | LDAP server URL | `""` |
|
||||
| `ldap.tlsInsecure` | Skip server cert verification | `false` |
|
||||
| `ldap.tlsCaCertFile` | CA certificate path | `""` |
|
||||
| `ldap.enableStartTls` | Use STARTTLS | `false` |
|
||||
| `ldap.baseDn` | Base DN for authentication | `""` |
|
||||
| `ldap.queryBind` | Bind user for searches | `""` |
|
||||
| `ldap.queryPassword` | Bind user password | `""` |
|
||||
| `ldap.userFilter` | User LDAP filter | `""` |
|
||||
| `ldap.adminFilter` | Admin LDAP filter | `""` |
|
||||
| `ldap.idAttribute` | User ID attribute | `uid` |
|
||||
| `ldap.nameAttribute` | User name attribute | `name` |
|
||||
| `ldap.mailAttribute` | User email attribute | `mail` |
|
||||
| `ldap.existingSecret` | Existing secret for LDAP | `""` |
|
||||
| `ldap.passwordKey` | Key for password in secret | `ldap-password` |
|
||||
|
||||
### OIDC Authentication
|
||||
|
||||
| Name | Description | Default |
|
||||
|------|-------------|---------|
|
||||
| `oidc.enabled` | Enable OIDC | `false` |
|
||||
| `oidc.signupEnabled` | Allow new users via OIDC | `true` |
|
||||
| `oidc.configurationUrl` | OIDC configuration URL | `""` |
|
||||
| `oidc.clientId` | Client ID | `""` |
|
||||
| `oidc.clientSecret` | Client secret | `""` |
|
||||
| `oidc.userGroup` | Required user group | `""` |
|
||||
| `oidc.adminGroup` | Admin group | `""` |
|
||||
| `oidc.autoRedirect` | Redirect to IdP on login | `false` |
|
||||
| `oidc.providerName` | Provider name on login button | `OAuth` |
|
||||
| `oidc.rememberMe` | Extend session ("Remember Me") | `false` |
|
||||
| `oidc.signingAlgorithm` | ID token signing algorithm | `RS256` |
|
||||
| `oidc.userClaim` | Claim to identify user | `email` |
|
||||
| `oidc.nameClaim` | Claim for user name | `name` |
|
||||
| `oidc.groupsClaim` | Claim for groups | `groups` |
|
||||
| `oidc.existingSecret` | Existing secret name | `""` |
|
||||
| `oidc.clientIdKey` | Key for client ID in secret | `oidc-client-id` |
|
||||
| `oidc.clientSecretKey` | Key for client secret in secret | `oidc-client-secret` |
|
||||
|
||||
### OpenAI Configuration
|
||||
|
||||
| Name | Description | Default |
|
||||
|------|-------------|---------|
|
||||
| `openai.enabled` | Enable OpenAI | `false` |
|
||||
| `openai.baseUrl` | OpenAI API base URL | `""` |
|
||||
| `openai.apiKey` | OpenAI API key | `""` |
|
||||
| `openai.model` | Model to use | `gpt-4o` |
|
||||
| `openai.enableImageServices` | Enable image services | `true` |
|
||||
| `openai.workers` | Workers per request | `2` |
|
||||
| `openai.sendDatabaseData` | Send DB data for accuracy | `true` |
|
||||
| `openai.requestTimeout` | Request timeout (seconds) | `60` |
|
||||
| `openai.existingSecret` | Existing secret name | `""` |
|
||||
| `openai.apiKeyKey` | Key for API key in secret | `openai-api-key` |
|
||||
|
||||
### Email Configuration
|
||||
|
||||
| Name | Description | Default |
|
||||
|------|-------------|---------|
|
||||
| `email.enabled` | Enable SMTP email | `false` |
|
||||
| `email.host` | SMTP host | `""` |
|
||||
| `email.port` | SMTP port | `587` |
|
||||
| `email.fromName` | From name | `Mealie` |
|
||||
| `email.authStrategy` | Auth strategy (`TLS`, `SSL`, `NONE`) | `TLS` |
|
||||
| `email.fromEmail` | From email address | `""` |
|
||||
| `email.user` | SMTP username | `""` |
|
||||
| `email.password` | SMTP password | `""` |
|
||||
| `email.existingSecret` | Existing secret for SMTP | `""` |
|
||||
| `email.userKey` | Key for username in secret | `smtp-user` |
|
||||
| `email.passwordKey` | Key for password in secret | `smtp-password` |
|
||||
|
||||
### TLS Configuration
|
||||
|
||||
| Name | Description | Default |
|
||||
|------|-------------|---------|
|
||||
| `tls.enabled` | Enable TLS | `false` |
|
||||
| `tls.certificatePath` | TLS certificate path | `""` |
|
||||
| `tls.privateKeyPath` | TLS private key path | `""` |
|
||||
| `tls.existingSecret` | Existing secret with TLS certs | `""` |
|
||||
| `tls.certificateKey` | Key for certificate in secret | `tls.crt` |
|
||||
| `tls.privateKeyKey` | Key for private key in secret | `tls.key` |
|
||||
|
||||
### Theme Configuration
|
||||
|
||||
| Name | Description | Default |
|
||||
|------|-------------|---------|
|
||||
| `theme.light.primary` | Light theme primary color | `#E58325` |
|
||||
| `theme.light.accent` | Light theme accent color | `#007A99` |
|
||||
| `theme.light.secondary` | Light theme secondary color | `#973542` |
|
||||
| `theme.light.success` | Light theme success color | `#43A047` |
|
||||
| `theme.light.info` | Light theme info color | `#1976D2` |
|
||||
| `theme.light.warning` | Light theme warning color | `#FF6D00` |
|
||||
| `theme.light.error` | Light theme error color | `#EF5350` |
|
||||
| `theme.dark.primary` | Dark theme primary color | `#E58325` |
|
||||
| `theme.dark.accent` | Dark theme accent color | `#007A99` |
|
||||
| `theme.dark.secondary` | Dark theme secondary color | `#973542` |
|
||||
| `theme.dark.success` | Dark theme success color | `#43A047` |
|
||||
| `theme.dark.info` | Dark theme info color | `#1976D2` |
|
||||
| `theme.dark.warning` | Dark theme warning color | `#FF6D00` |
|
||||
| `theme.dark.error` | Dark theme error color | `#EF5350` |
|
||||
|
||||
### Resource Parameters
|
||||
|
||||
| Name | Description | Default |
|
||||
|------|-------------|---------|
|
||||
| `resources` | Resource limits and requests | `{}` |
|
||||
|
||||
### Health Check Parameters
|
||||
|
||||
| Name | Description | Default |
|
||||
|------|-------------|---------|
|
||||
| `probes.liveness.enabled` | Enable liveness probe | `true` |
|
||||
| `probes.liveness.path` | Liveness probe path | `/` |
|
||||
| `probes.liveness.initialDelaySeconds` | Liveness initial delay | `60` |
|
||||
| `probes.liveness.periodSeconds` | Liveness period | `30` |
|
||||
| `probes.readiness.enabled` | Enable readiness probe | `true` |
|
||||
| `probes.readiness.path` | Readiness probe path | `/` |
|
||||
| `probes.readiness.initialDelaySeconds` | Readiness initial delay | `30` |
|
||||
| `probes.readiness.periodSeconds` | Readiness period | `10` |
|
||||
|
||||
### Autoscaling Parameters
|
||||
|
||||
| Name | Description | Default |
|
||||
|------|-------------|---------|
|
||||
| `autoscaling.enabled` | Enable HPA | `false` |
|
||||
| `autoscaling.minReplicas` | Min replicas | `1` |
|
||||
| `autoscaling.maxReplicas` | Max replicas | `3` |
|
||||
| `autoscaling.targetCPUUtilizationPercentage` | Target CPU | `80` |
|
||||
| `autoscaling.targetMemoryUtilizationPercentage` | Target memory | `80` |
|
||||
|
||||
## Troubleshooting
|
||||
|
||||
Common issues and solutions:
|
||||
|
||||
1. **Database connection issues**: Verify database credentials and network connectivity
|
||||
2. **Persistence issues**: Check StorageClass and PVC configuration
|
||||
3. **Authentication problems**: Verify LDAP/OIDC configuration and network access
|
||||
4. **Performance issues**: Adjust resource limits and consider using external database
|
||||
|
||||
For more detailed troubleshooting, check the application logs:
|
||||
- **Database connection issues**: Verify credentials and network connectivity
|
||||
- **Persistence issues**: Check StorageClass and PVC configuration
|
||||
- **Authentication problems**: Verify LDAP/OIDC configuration and network access
|
||||
- **Performance issues**: Adjust resource limits and consider using an external database
|
||||
|
||||
```bash
|
||||
kubectl logs -f deployment/mealie
|
||||
```
|
||||
kubectl describe pod -l app.kubernetes.io/name=mealie
|
||||
```
|
||||
|
||||
## Links
|
||||
|
||||
- [Mealie GitHub](https://github.com/mealie-recipes/mealie)
|
||||
- [Chart Source](https://github.com/rtomik/helm-charts/tree/main/charts/mealie)
|
||||
|
||||
Reference in New Issue
Block a user