Merge pull request #27 from homarr-labs/26-feat-update-app-to-version…

…-v100-beta10 feat!(app-version): update app version to v1.0.0-beta.10
homarr-labs · Jan 2, 2025 · d1adbdd · d1adbdd
2 parents fb7415e + 5fc1e13
commit d1adbdd
Show file tree

Hide file tree

Showing 7 changed files with 179 additions and 117 deletions.
diff --git a/charts/homarr/Chart.yaml b/charts/homarr/Chart.yaml
@@ -3,9 +3,9 @@ name: homarr
 description: A Helm chart to deploy homarr for Kubernetes
 home: https://homarr-labs.github.io/charts/charts/homarr/
 type: application
-version: 0.2.1
+version: 1.0.0
 # renovate datasource=docker depName=ghcr.io/homarr-labs/homarr
-appVersion: "v1.0.0-beta.4"
+appVersion: "v1.0.0-beta.10"
 icon: https://raw.githubusercontent.com/homarr-labs/charts/refs/heads/main/charts/homarr/icon.svg
 kubeVersion: ">=1.22.0-0"
 dependencies:
@@ -24,7 +24,7 @@ annotations:
     url: https://homarr-labs.github.io/charts/pgp_keys.asc
   artifacthub.io/changes: |-
     - kind: changed
-      description: update chart to version v1.0.0-beta.4
+      description: update app version to v1.0.0-beta.10
   artifacthub.io/links: |-
     - name: App Source
       url: https://github.com/homarr-labs/homarr

diff --git a/charts/homarr/README.md b/charts/homarr/README.md
diff --git a/charts/homarr/README_CONFIG.md.gotmpl b/charts/homarr/README_CONFIG.md.gotmpl
@@ -17,12 +17,12 @@ Below is an exhaustive list of all secrets:
 
 <center>
 
-| FEATURE  | SECRET NAME             |      SECRET KEYS                                             |             Required           |
-|----------|-------------------------|--------------------------------------------------------------|--------------------------------|
-| NEXT AUTH| auth-credentials-secret |  auth-secret                                                 | Yes                            |
-| OIDC     | auth-oidc-secret        |  oidc-client-id<br>oidc-client-secret                        | No                             |
-| LDAP     | auth-ldap-secret        |  bind-password                                               | No                             |
-| DATABASE | db-secret               |  db-url<br>mysql-root-password<br>mysql-password             | Depends (see Database section) |
+| FEATURE   | SECRET NAME             | SECRET KEYS                                                          | Required                                                              |
+|-----------|-------------------------|----------------------------------------------------------------------|-----------------------------------------------------------------------|
+| NEXT AUTH | auth-credentials-secret | auth-secret                                                          | Yes                                                                   |
+| OIDC      | auth-oidc-secret        | oidc-client-id<br>oidc-client-secret                                 | No                                                                    |
+| LDAP      | auth-ldap-secret        | bind-password                                                        | No                                                                    |
+| DATABASE  | db-secret               | db-encryption-key<br>db-url<br>mysql-root-password<br>mysql-password | Depends (see Database section) at least db-encryption-key is required |
 
 </center>
 
@@ -51,19 +51,32 @@ You have multiple options for configuring the database:
 
 <center>
 
-| DRIVER TYPE   | Persistence mode                |
-|---------------|---------------------------------|
-| better-sqlite3| Pod disk                        |
-| better-sqlite3| `homarr-database` PVC           |
-| mysql2        | MySql database chart dependency |
-| mysql2        | External MySql database         |
+| DRIVER TYPE    | Persistence mode                |
+|----------------|---------------------------------|
+| better-sqlite3 | Pod disk                        |
+| better-sqlite3 | `homarr-database` PVC           |
+| mysql2         | MySql database chart dependency |
+| mysql2         | External MySql database         |
 
 </center>
 
 #### Pod disk
 
 No additional configuration is required. However, keep in mind that if the pod restarts, all data will be lost. This setup is not *recommended* for production use.
 
+To create the necessary database secret, execute the following command:
+
+<details>
+<summary>Required Secrets</summary>
+
+````yaml
+kubectl create secret generic db-secret \
+--from-literal=db-encryption-key='<SECRET_ENCRYPTION_KEY_SECRET_TO_CHANGE>' \
+--namespace homarr
+````
+
+</details>
+
 #### PVC
 
 To persist data, you need to enable the `homarr-database` PVC. This will store the Homarr database on a mounted volume.
@@ -81,6 +94,17 @@ kubectl create secret generic auth-credentials-secret \
 
 </details>
 
+<details>
+<summary>DB Required Secrets</summary>
+
+````yaml
+kubectl create secret generic db-secret \
+--from-literal=db-encryption-key='<SECRET_ENCRYPTION_KEY_SECRET_TO_CHANGE>' \
+--namespace homarr
+````
+
+</details>
+
 Bellow an example of the override value file :
 
 <details>
@@ -107,6 +131,7 @@ To create the necessary database secrets, execute the following command:
 
 ````yaml
 kubectl create secret generic db-secret \
+--from-literal=db-encryption-key='<SECRET_ENCRYPTION_KEY_SECRET_TO_CHANGE>' \
 --from-literal=db-url='mysql://homarr:your-db-password1@homarr-mysql:3306/homarrdb' \
 --from-literal=mysql-root-password='your-db-password1' \
 --from-literal=mysql-password='your-db-password2' \
@@ -140,6 +165,7 @@ To create the necessary database secrets, execute the following command:
 
 ````yaml
 kubectl create secret generic db-secret \
+--from-literal=db-encryption-key='<SECRET_ENCRYPTION_KEY_SECRET_TO_CHANGE>' \
 --from-literal=db-url='mysql://user:password@host:port/homarrdb' \
 --namespace homarr
 ````

diff --git a/charts/homarr/templates/homarr-dc.yaml b/charts/homarr/templates/homarr-dc.yaml
@@ -136,6 +136,11 @@ spec:
                  name: {{ .Values.envSecrets.authOidcCredentials.existingSecret }}
                  key: {{ .Values.envSecrets.authOidcCredentials.oidcClientSecret }}
             {{- end }}
+           - name: SECRET_ENCRYPTION_KEY
+             valueFrom:
+               secretKeyRef:
+                 name: {{ .Values.envSecrets.dbCredentials.existingSecret }}
+                 key: {{ .Values.envSecrets.dbCredentials.dbEncryptionKey }}
 
           resources:
             {{- toYaml .Values.resources | nindent 12 }}

diff --git a/charts/homarr/values.yaml b/charts/homarr/values.yaml
@@ -10,7 +10,7 @@ image:
   # -- Image pull policy
   pullPolicy: IfNotPresent
   # -- Overrides the image tag whose default is the chart appVersion
-  tag: "v1.0.0-beta.4"
+  tag: "v1.0.0-beta.10"
 
 env:
   # -- Your local time zone
@@ -86,6 +86,9 @@ envSecrets:
   dbCredentials:
     # -- Name of existing secret containing DB credentials
     existingSecret: "db-secret"
+    # -- Secret key for SECRET_ENCRYPTION_KEY
+    # can be generated with `openssl rand -hex 32`
+    dbEncryptionKey: "db-encryption-key"
     # -- Secret key for DB_URL
     # Example for internal database: `mysql://username:password@homarr-mysql:3306/homarrdb`
     dbUrlKey: "db-url"

diff --git a/development/README.md b/development/README.md
@@ -48,12 +48,13 @@ kubectl create namespace homarr
 
 ```bash
 kubectl create secret generic auth-credentials-secret \
-  --from-literal=auth-secret='mAxnWLFaQE59MauTrCTm5sUq5xf3sdG5m0eKnp2e3OU' \
+--from-literal=auth-secret='mAxnWLFaQE59MauTrCTm5sUq5xf3sdG5m0eKnp2e3OU' \
 --namespace homarr
 ```
 
 ```bash
 kubectl create secret generic db-secret \
+--from-literal=db-encryption-key='d4d0dd977c9795b988e68f115f444c40334a63a391cfb9b3a0857d2d77deff03'  \
 --from-literal=db-url='mysql://homarr:your-db-password@homarr-mysql:3306/homarrdb' \
 --from-literal=mysql-root-password='your-db-password' \
 --from-literal=mysql-password='your-db-password' \
@@ -67,25 +68,25 @@ kubectl create secret generic db-secret \
 #### Internal Database
 
 ```bash
-helm install homarr ../charts/homarr/homarr-0.0.1.tgz --namespace homarr --values=internal-db/override-internal-db-local-docker-img.yaml
+helm install homarr ../charts/homarr/homarr-1.0.0.tgz --namespace homarr --values=internal-db/override-internal-db-local-docker-img.yaml
 ```
 
 #### External Database
 
 ```bash
-helm install homarr ../charts/homarr/homarr-0.0.1.tgz --namespace homarr --values=external-db/override-external-db-local-docker-img.yaml
+helm install homarr ../charts/homarr/homarr-1.0.0.tgz --namespace homarr --values=external-db/override-external-db-local-docker-img.yaml
 ```
 
 ### Use github docker image
 
 ```bash
-helm install homarr ../charts/homarr/homarr-0.0.1.tgz --namespace homarr --values=internal-db/override-internal-db.yaml
+helm install homarr ../charts/homarr/homarr-1.0.0.tgz --namespace homarr --values=internal-db/override-internal-db.yaml
 ```
 
 #### External Database
 
 ```bash
-helm install homarr ../charts/homarr/homarr-0.0.1.tgz --namespace homarr --values=external-db/override-external-db.yaml
+helm install homarr ../charts/homarr/homarr-1.0.0.tgz --namespace homarr --values=external-db/override-external-db.yaml
 ```
 
 ## Port forwarding Homarr

diff --git a/hack/templates/README.md.gotmpl b/hack/templates/README.md.gotmpl
@@ -82,7 +82,7 @@ The command removes all the Kubernetes components associated with the chart **in
 {{- end -}}
 
 {{- define "custom.configuration.readValues" -}}
-Read through the [values.yaml](./values.yaml) file. It has several commented out suggested values.
+Read through the [values.yaml](https://github.com/homarr-labs/charts/blob/dev/charts/homarr/values.yaml) file. It has several commented out suggested values.
 {{- end -}}
 
 {{- define "custom.configuration.example.set" -}}