feat(documentation): Added mealie readme content and adjusted config
This commit is contained in:
parent
7c8a584b75
commit
15ce4b1e30
3 changed files with 37 additions and 28 deletions
|
|
@ -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>`
|
||||
|
|
@ -33,7 +33,7 @@ spec:
|
|||
- name: TZ
|
||||
value: Europe/London
|
||||
- name: BASE_URL
|
||||
value: https://mealie.foxhawk.co.uk
|
||||
value: <mealie base url>
|
||||
- name: DB_ENGINE
|
||||
value: postgres
|
||||
- name: POSTGRES_USER
|
||||
|
|
@ -52,31 +52,31 @@ spec:
|
|||
value: "5432"
|
||||
- name: POSTGRES_DB
|
||||
value: mealie
|
||||
- name: OIDC_AUTH_ENABLED
|
||||
value: "true"
|
||||
- name: OIDC_SIGNUP_ENABLED
|
||||
value: "true"
|
||||
- name: OIDC_CONFIGURATION_URL
|
||||
value: "https://authentik.foxhawk.co.uk/application/o/mealie/.well-known/openid-configuration"
|
||||
- name: OIDC_CLIENT_ID
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
name: mealie-oidc
|
||||
key: client-id
|
||||
- name: OIDC_CLIENT_SECRET
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
name: mealie-oidc
|
||||
key: client-secret
|
||||
- name: OIDC_ADMIN_GROUP
|
||||
valueFrom:
|
||||
secretKeyRef:
|
||||
name: mealie-oidc
|
||||
key: admin-group
|
||||
- name: OIDC_AUTO_REDIRECT
|
||||
value: "false"
|
||||
- name: OIDC_PROVIDER_NAME
|
||||
value: "Authentik"
|
||||
# - name: OIDC_AUTH_ENABLED
|
||||
# value: "true"
|
||||
# - name: OIDC_SIGNUP_ENABLED
|
||||
# value: "true"
|
||||
# - name: OIDC_CONFIGURATION_URL
|
||||
# value: <oidc config url>
|
||||
# - name: OIDC_CLIENT_ID
|
||||
# valueFrom:
|
||||
# secretKeyRef:
|
||||
# name: mealie-oidc
|
||||
# key: client-id
|
||||
# - name: OIDC_CLIENT_SECRET
|
||||
# valueFrom:
|
||||
# secretKeyRef:
|
||||
# name: mealie-oidc
|
||||
# key: client-secret
|
||||
# - name: OIDC_ADMIN_GROUP
|
||||
# valueFrom:
|
||||
# secretKeyRef:
|
||||
# name: mealie-oidc
|
||||
# key: admin-group
|
||||
# - name: OIDC_AUTO_REDIRECT
|
||||
# value: "false"
|
||||
# - name: OIDC_PROVIDER_NAME
|
||||
# value: <provider name>
|
||||
volumes:
|
||||
- name: mealie-pvc
|
||||
persistentVolumeClaim:
|
||||
|
|
|
|||
|
|
@ -7,10 +7,10 @@ metadata:
|
|||
spec:
|
||||
tls:
|
||||
- hosts:
|
||||
- mealie.foxhawk.co.uk
|
||||
- <mealie domain name>
|
||||
secretName: mealie-tls
|
||||
rules:
|
||||
- host: mealie.foxhawk.co.uk
|
||||
- host: <mealie domain name>
|
||||
http:
|
||||
paths:
|
||||
- pathType: Prefix
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue