feat(documentation): Added mealie readme content and adjusted config

This commit is contained in:
Fishandchips321 2026-04-15 14:55:48 +01:00
parent 7c8a584b75
commit 15ce4b1e30
3 changed files with 37 additions and 28 deletions

View file

@ -0,0 +1,9 @@
# Mealie
Mealie is a recipe management service with features for creating shopping lists from recipes and a meal planner.
## Using this kubernetes config
Firstly, you will need to create a generic kubernetes secret with the database username and password. You can do this with the command `kubectl create secret generic mealie-db --from-literal=username=<username here> --from-literal='password=<password here>'`. Make sure to use a secure password.
Then you will need to set mealie's hostname in `deployment.yml` under the env variables and in `ingress.yml`. Ensure the one in `deployment.yml` contains `https://` and that the one in `ingress.yml` is just the hostname (no `https://`). This config assumes you have cert-manager installed on your cluster, so if you want to provide HTTPS another way, feel free to comment out the `spec.tls` section (the annotation shouldn't affect anything, but you can comment it out as well if you want)
If you want to use OIDC to log into mealie, uncomment the OIDC environment variables and fill in the provider name and OIDC configuration url (the one with `.well-known/...` in the path). [put here a section about what callback urls to use in your provider]. Also, create another kubernetes generic secret to hold the OIDC sensitive config. You can do this with the command `kubectl create secret generic mealie-oidc --from-literal=client-id=<OIDC client ID> --from-literal=client-secret=<OIDC client secret> --from-literal=admin-group=<OIDC group for mealie admins>`

View file

@ -33,7 +33,7 @@ spec:
- name: TZ - name: TZ
value: Europe/London value: Europe/London
- name: BASE_URL - name: BASE_URL
value: https://mealie.foxhawk.co.uk value: <mealie base url>
- name: DB_ENGINE - name: DB_ENGINE
value: postgres value: postgres
- name: POSTGRES_USER - name: POSTGRES_USER
@ -52,31 +52,31 @@ spec:
value: "5432" value: "5432"
- name: POSTGRES_DB - name: POSTGRES_DB
value: mealie value: mealie
- name: OIDC_AUTH_ENABLED # - name: OIDC_AUTH_ENABLED
value: "true" # value: "true"
- name: OIDC_SIGNUP_ENABLED # - name: OIDC_SIGNUP_ENABLED
value: "true" # value: "true"
- name: OIDC_CONFIGURATION_URL # - name: OIDC_CONFIGURATION_URL
value: "https://authentik.foxhawk.co.uk/application/o/mealie/.well-known/openid-configuration" # value: <oidc config url>
- name: OIDC_CLIENT_ID # - name: OIDC_CLIENT_ID
valueFrom: # valueFrom:
secretKeyRef: # secretKeyRef:
name: mealie-oidc # name: mealie-oidc
key: client-id # key: client-id
- name: OIDC_CLIENT_SECRET # - name: OIDC_CLIENT_SECRET
valueFrom: # valueFrom:
secretKeyRef: # secretKeyRef:
name: mealie-oidc # name: mealie-oidc
key: client-secret # key: client-secret
- name: OIDC_ADMIN_GROUP # - name: OIDC_ADMIN_GROUP
valueFrom: # valueFrom:
secretKeyRef: # secretKeyRef:
name: mealie-oidc # name: mealie-oidc
key: admin-group # key: admin-group
- name: OIDC_AUTO_REDIRECT # - name: OIDC_AUTO_REDIRECT
value: "false" # value: "false"
- name: OIDC_PROVIDER_NAME # - name: OIDC_PROVIDER_NAME
value: "Authentik" # value: <provider name>
volumes: volumes:
- name: mealie-pvc - name: mealie-pvc
persistentVolumeClaim: persistentVolumeClaim:

View file

@ -7,10 +7,10 @@ metadata:
spec: spec:
tls: tls:
- hosts: - hosts:
- mealie.foxhawk.co.uk - <mealie domain name>
secretName: mealie-tls secretName: mealie-tls
rules: rules:
- host: mealie.foxhawk.co.uk - host: <mealie domain name>
http: http:
paths: paths:
- pathType: Prefix - pathType: Prefix