Skip to content

Commit b07f753

Browse files
Merge pull request #439 from homarr-labs/docs/update-helm-docs
Update Helm chart documentation
2 parents 282e600 + c555bc7 commit b07f753

File tree

1 file changed

+24
-11
lines changed
  • docs/getting-started/installation

1 file changed

+24
-11
lines changed

docs/getting-started/installation/helm.md

Lines changed: 24 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
<img src="https://raw.githubusercontent.com/homarr-labs/charts/refs/heads/main/charts/homarr/icon.svg" align="right" width="92" alt="homarr logo">
44

5-
![Version: 7.3.0](https://img.shields.io/badge/Version-7.3.0-informational?style=flat)
5+
![Version: 8.0.0](https://img.shields.io/badge/Version-8.0.0-informational?style=flat)
66
![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat)
77
![AppVersion: v1.41.0](https://img.shields.io/badge/AppVersion-v1.41.0-informational?style=flat)
88

@@ -76,11 +76,12 @@ To avoid including sensitive information in plain text within your version contr
7676

7777
Below is an exhaustive list of all secrets:
7878

79-
| FEATURE | SECRET NAME | SECRET KEYS | Required |
80-
|-----------|-------------------------|-----------------------------------------|-----------------------------------------------------------------------|
81-
| OIDC | auth-oidc-secret | oidc-client-id<br>oidc-client-secret | No |
82-
| LDAP | auth-ldap-secret | bind-password | No |
83-
| DATABASE | db-secret | db-encryption-key<br>db-url | Depends (see Database section) at least db-encryption-key is required |
79+
| FEATURE | SECRET NAME | SECRET KEYS | Required |
80+
|-----------|-------------------------|-----------------------------------------|----------|
81+
| OIDC | auth-oidc-secret | oidc-client-id<br>oidc-client-secret | No |
82+
| LDAP | auth-ldap-secret | bind-password | No |
83+
| DATABASE | db-secret | db-url | No |
84+
| DATABASE | db-encryption | db-encryption-key | yes |
8485

8586
### Database
8687

@@ -103,7 +104,7 @@ To create the necessary database secret, execute the following command:
103104
<summary>Required Secrets</summary>
104105

105106
````yaml
106-
kubectl create secret generic db-secret \
107+
kubectl create secret generic db-encryption \
107108
--from-literal=db-encryption-key='<SECRET_ENCRYPTION_KEY_SECRET_TO_CHANGE>' \
108109
--namespace homarr
109110
````
@@ -120,7 +121,7 @@ Associated secret to create :
120121
<summary>DB Required Secrets</summary>
121122

122123
````yaml
123-
kubectl create secret generic db-secret \
124+
kubectl create secret generic db-encryption \
124125
--from-literal=db-encryption-key='<SECRET_ENCRYPTION_KEY_SECRET_TO_CHANGE>' \
125126
--namespace homarr
126127
````
@@ -150,8 +151,13 @@ To create the necessary database secrets, execute the following command:
150151
<summary>Required Secrets</summary>
151152

152153
````yaml
153-
kubectl create secret generic db-secret \
154+
kubectl create secret generic db-encryption \
154155
--from-literal=db-encryption-key='<SECRET_ENCRYPTION_KEY_SECRET_TO_CHANGE>' \
156+
--namespace homarr
157+
````
158+
159+
````yaml
160+
kubectl create secret generic db-secret \
155161
--from-literal=db-url='mysql://user:password@host:port/homarrdb' \
156162
--namespace homarr
157163
````
@@ -176,11 +182,17 @@ To create the necessary database secrets, execute the following command:
176182
<summary>Required Secrets</summary>
177183

178184
````yaml
179-
kubectl create secret generic db-secret \
185+
kubectl create secret generic db-encryption \
180186
--from-literal=db-encryption-key='<SECRET_ENCRYPTION_KEY_SECRET_TO_CHANGE>' \
187+
--namespace homarr
188+
````
189+
190+
````yaml
191+
kubectl create secret generic db-secret \
181192
--from-literal=db-url='postgresql://user:password@host:port/homarrdb' \
182193
--namespace homarr
183194
````
195+
184196
</details>
185197

186198
Below is an example of the override values file:
@@ -400,9 +412,10 @@ All available values are listed on the [artifacthub](https://artifacthub.io/pack
400412
| envSecrets.authOidcCredentials.existingSecret | string | `"auth-oidc-secret"` | Name of existing secret containing OIDC credentials |
401413
| envSecrets.authOidcCredentials.oidcClientId | string | `"oidc-client-id"` | ID of OIDC client (application) secret key |
402414
| envSecrets.authOidcCredentials.oidcClientSecret | string | `"oidc-client-secret"` | Secret of OIDC client (application) secret key |
403-
| envSecrets.dbCredentials.dbEncryptionKey | string | `"db-encryption-key"` | Secret key for SECRET_ENCRYPTION_KEY can be generated with `openssl rand -hex 32` |
404415
| envSecrets.dbCredentials.dbUrlKey | string | `"db-url"` | Secret key for DB_URL Example for external database: `mysql://username:password@host:port/homarrdb` or `postgresql://username:password@host:port/homarrdb` |
405416
| envSecrets.dbCredentials.existingSecret | string | `"db-secret"` | Name of existing secret containing DB credentials |
417+
| envSecrets.dbEncryption.existingSecret | string | `"db-encryption"` | Name of existing secret containing DB encryption |
418+
| envSecrets.dbEncryption.key | string | `"db-encryption-key"` | Secret key for SECRET_ENCRYPTION_KEY can be generated with `openssl rand -hex 32` |
406419
| fullnameOverride | string | `""` | Overrides chart's fullname |
407420
| hostAliases | list | `[]` | Add static entries to /etc/hosts in the Pod. This is useful in the following cases: - You are running in a dual-stack cluster (IPv4 + IPv6) and want to force usage of IPv4 for specific hostnames - Your application is having DNS resolution issues or IPv6 preference issues - You need to override or simulate DNS entries without changing global DNS - You are running in an air-gapped or isolated environment without external DNS Example: hostAliases: - ip: "192.168.1.10" hostnames: - "example.com" - "example.internal" |
408421
| httproute | object | `{"enabled":false,"hostnames":["chart-example.local"],"parentRefs":[{"name":"my-gateway","namespace":"default"}],"rules":[{"backendRefs":[{"name":"homarr","port":8080}],"filters":[],"matches":[{"path":{"type":"PathPrefix","value":"/"}}]}]}` | Gateway API HTTPRoute configuration |

0 commit comments

Comments
 (0)