|
2 | 2 |
|
3 | 3 | <img src="https://raw.githubusercontent.com/homarr-labs/charts/refs/heads/main/charts/homarr/icon.svg" align="right" width="92" alt="homarr logo"> |
4 | 4 |
|
5 | | - |
| 5 | + |
6 | 6 |  |
7 | 7 |  |
8 | 8 |
|
@@ -76,31 +76,23 @@ To avoid including sensitive information in plain text within your version contr |
76 | 76 |
|
77 | 77 | Below is an exhaustive list of all secrets: |
78 | 78 |
|
79 | | -<center> |
80 | | - |
81 | | -| FEATURE | SECRET NAME | SECRET KEYS | Required | |
| 79 | +| FEATURE | SECRET NAME | SECRET KEYS | Required | |
82 | 80 | |-----------|-------------------------|-----------------------------------------|-----------------------------------------------------------------------| |
83 | 81 | | OIDC | auth-oidc-secret | oidc-client-id<br>oidc-client-secret | No | |
84 | 82 | | LDAP | auth-ldap-secret | bind-password | No | |
85 | 83 | | DATABASE | db-secret | db-encryption-key<br>db-url | Depends (see Database section) at least db-encryption-key is required | |
86 | 84 |
|
87 | | -</center> |
88 | | - |
89 | 85 | ### Database |
90 | 86 |
|
91 | 87 | You have multiple options for configuring the database: |
92 | 88 |
|
93 | | -<center> |
94 | | - |
95 | 89 | | DRIVER TYPE | Persistence mode | |
96 | 90 | |----------------|---------------------------------| |
97 | 91 | | better-sqlite3 | Pod disk | |
98 | 92 | | better-sqlite3 | homarr-database PVC | |
99 | 93 | | mysql2 | External MySql database | |
100 | 94 | | node-postgres | External Postgresql database | |
101 | 95 |
|
102 | | -</center> |
103 | | - |
104 | 96 | #### Pod disk |
105 | 97 |
|
106 | 98 | 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. |
@@ -378,7 +370,7 @@ All available values are listed on the [artifacthub](https://artifacthub.io/pack |
378 | 370 | | autoscaling.targetCPUUtilizationPercentage | int | `80` | Target CPU utilization for autoscaling | |
379 | 371 | | containerPorts | object | `{"http":{"port":7575,"protocol":"TCP"}}` | containerPorts defines the ports to open on the container. It is a map where each entry specifies: - `port` (int) (required): The port number to expose inside the container. - `protocol` (string) (required): The network protocol (TCP or UDP) used for the port. - `disabled` (bool) : Optional flag to disable this port (defaults to false). Can be overridden via Helm values. By default, this configuration exposes TCP port 7575 with the name `http`. | |
380 | 372 | | database.migrationEnabled | bool | `true` | Database migration configuration. DB_MIGRATIONS_DISABLED Set to `true` to disable database migrations. Migrations are enabled by default (`false`). | |
381 | | -| database.type | string | `"sqlite"` | Database type: sqlite | mysql | postgresql | |
| 373 | +| database.type | string | `"sqlite"` | Database type: sqlite, mysql or postgresql | |
382 | 374 | | env.AUTH_LDAP_BASE | string | `nil` | Base dn of your LDAP server | |
383 | 375 | | env.AUTH_LDAP_BIND_DN | string | `nil` | User used for finding users and groups | |
384 | 376 | | env.AUTH_LDAP_GROUP_CLASS | string | `"groupOfUniqueNames"` | Class used for querying groups | |
@@ -432,7 +424,6 @@ All available values are listed on the [artifacthub](https://artifacthub.io/pack |
432 | 424 | | ingress.tls | list | `[]` | Ingress TLS configuration | |
433 | 425 | | livenessProbe.httpGet.path | string | `"/api/health/live"` | This is the liveness check endpoint used by Kubernetes to determine if the application is still running. | |
434 | 426 | | livenessProbe.httpGet.port | int | `7575` | The port on which the liveness check will be performed. This must be the same as the container port exposed by the application. | |
435 | | -| mysql | object | See [values.yaml](https://github.com/homarr-labs/charts/blob/dev/charts/homarr/values.yaml) | Enable and configure Mysql database subchart under this key. For more options see [Mysql chart documentation](https://github.com/bitnami/charts/tree/main/bitnami/mysql) | |
436 | 427 | | nameOverride | string | `""` | Overrides chart's name | |
437 | 428 | | nodeSelector | object | `{}` | Node selectors for pod scheduling | |
438 | 429 | | persistence.homarrDatabase.accessMode | string | `"ReadWriteOnce"` | homarr-database access mode | |
|
0 commit comments