From 850ea9bec81e7d5cfa9f61f525ccecb56901d609 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Tue, 8 Oct 2024 13:09:22 +0000 Subject: [PATCH] docs(charts): :memo: write updated reademe --- charts/jellyfin/README.md | 33 +++++++++++++++++++++++++++++++++ 1 file changed, 33 insertions(+) diff --git a/charts/jellyfin/README.md b/charts/jellyfin/README.md index 476c4ba..9f3c895 100644 --- a/charts/jellyfin/README.md +++ b/charts/jellyfin/README.md @@ -75,17 +75,23 @@ helm install -f values.yaml | nameOverride | string | `""` | | | nodeSelector | object | `{}` | | | persistence.config.accessMode | string | `"ReadWriteOnce"` | | +| persistence.config.annotations | object | `{}` | Custom annotations to be added to the PVC | | persistence.config.enabled | bool | `false` | | +| persistence.config.labels | object | `{}` | Custom labels to be added to the PVC | | persistence.config.size | string | `"1Gi"` | | | persistence.config.storageClass | string | `"-"` | If undefined (the default) or set to null, no storageClassName spec is set, choosing the default provisioner. | | persistence.extraExistingClaimMounts | list | `[]` | Add aditional PVs/PVCs to our container. Check values.yaml to see an example. | | persistence.media.accessMode | string | `"ReadWriteOnce"` | | +| persistence.media.annotations | object | `{}` | Custom annotations to be added to the PVC | | persistence.media.enabled | bool | `false` | | +| persistence.media.labels | object | `{}` | Custom labels to be added to the PVC | | persistence.media.size | string | `"10Gi"` | | | persistence.media.storageClass | string | `"-"` | If undefined (the default) or set to null, no storageClassName spec is set, choosing the default provisioner. | +| podSecurityContext | object | `{}` | SecurityContext configuration for the Jellyfin pod | | readinessProbe | object | `{"enabled":true,"initialDelaySeconds":10}` | Larger libraries may need to increase the readinessProbe and livenessProbe timeouts. Start by increasing the initialDelaySeconds. | | replicaCount | int | `1` | Number of jellyfin replicas to start. Should be left at 1 | | resources | object | `{}` | | +| securityContext | object | `{}` | SecurityContext configuration for the Jellyfin container | | service.annotations | object | `{}` | | | service.labels | object | `{}` | | | service.loadBalancerIP | string | `nil` | | @@ -95,3 +101,30 @@ helm install -f values.yaml ---------------------------------------------- Autogenerated from chart metadata using [helm-docs v1.14.2](https://github.com/norwoodj/helm-docs/releases/v1.14.2) + +## Hardware acceleration + +Out of the box the pod does not have the necessary permissions to enable hardware acceleration (HWA) in Jellyfin. +Adding the following Helm values should make it enable you to use hardware acceleration features. +Some settings may need to be tweaked depending on the type of device (Intel/AMD/NVIDIA/...) and your container runtime. + +Please refer to the Jellyfin upstream documentation for more information about hardware acceleration: + +```yaml +securityContext: + capabilities: + add: + - "SYS_ADMIN" + drop: + - "ALL" + privileged: false + +extraVolumes: + - name: hwa + hostPath: + path: /dev/dri + +extraVolumeMounts: + - name: hwa + mountPath: /dev/dri +```