Skip to content

Commit 157161c

Browse files
Merge pull request #429 from homarr-labs/docs/update-helm-docs
Update Helm chart documentation
2 parents 3474db4 + e65a9b7 commit 157161c

File tree

1 file changed

+3
-12
lines changed
  • docs/getting-started/installation

1 file changed

+3
-12
lines changed

docs/getting-started/installation/helm.md

Lines changed: 3 additions & 12 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.0.0](https://img.shields.io/badge/Version-7.0.0-informational?style=flat)
5+
![Version: 7.1.0](https://img.shields.io/badge/Version-7.1.0-informational?style=flat)
66
![Type: application](https://img.shields.io/badge/Type-application-informational?style=flat)
77
![AppVersion: v1.39.0](https://img.shields.io/badge/AppVersion-v1.39.0-informational?style=flat)
88

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

7777
Below is an exhaustive list of all secrets:
7878

79-
<center>
80-
81-
| FEATURE | SECRET NAME | SECRET KEYS | Required |
79+
| FEATURE | SECRET NAME | SECRET KEYS | Required |
8280
|-----------|-------------------------|-----------------------------------------|-----------------------------------------------------------------------|
8381
| OIDC | auth-oidc-secret | oidc-client-id<br>oidc-client-secret | No |
8482
| LDAP | auth-ldap-secret | bind-password | No |
8583
| DATABASE | db-secret | db-encryption-key<br>db-url | Depends (see Database section) at least db-encryption-key is required |
8684

87-
</center>
88-
8985
### Database
9086

9187
You have multiple options for configuring the database:
9288

93-
<center>
94-
9589
| DRIVER TYPE | Persistence mode |
9690
|----------------|---------------------------------|
9791
| better-sqlite3 | Pod disk |
9892
| better-sqlite3 | homarr-database PVC |
9993
| mysql2 | External MySql database |
10094
| node-postgres | External Postgresql database |
10195

102-
</center>
103-
10496
#### Pod disk
10597

10698
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
378370
| autoscaling.targetCPUUtilizationPercentage | int | `80` | Target CPU utilization for autoscaling |
379371
| 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`. |
380372
| 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 |
382374
| env.AUTH_LDAP_BASE | string | `nil` | Base dn of your LDAP server |
383375
| env.AUTH_LDAP_BIND_DN | string | `nil` | User used for finding users and groups |
384376
| 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
432424
| ingress.tls | list | `[]` | Ingress TLS configuration |
433425
| livenessProbe.httpGet.path | string | `"/api/health/live"` | This is the liveness check endpoint used by Kubernetes to determine if the application is still running. |
434426
| 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) |
436427
| nameOverride | string | `""` | Overrides chart's name |
437428
| nodeSelector | object | `{}` | Node selectors for pod scheduling |
438429
| persistence.homarrDatabase.accessMode | string | `"ReadWriteOnce"` | homarr-database access mode |

0 commit comments

Comments
 (0)