helm-media-servarr

Homarr Helm Chart

This Helm chart installs Homarr, a server dashboard, in a Kubernetes cluster.

This README covers the basics of customising and installation

• Installation
• Configuration
  • Application Configuration
  • Volumes
  • Ingress
  • Advanced
• Upgrading
• Uninstallation
• Support

Installation

Install this helm chart using the following command:

helm repo add media-servarr https://media-servarr.shw.al/charts

helm install homarr media-servarr/homarr

Pointing the host media-servarr.local to your kubernetes cluster will then allow you to access the application at the default location of http://media-servarr.local/homarr/

Configuration

Here are some examples of configuration you may want to override (and include in installation with -f myvalues.yaml).

Application Configuration

You can change the default port in the application config

application:
  port: 7575

Volumes

Three volumes are available by default:

• app-data-configs - Dashboard files
• data - Homarr data
• app-data-icons - Icons

deployment:
  ...
  volumes:
    # Dashboard (config) files
    app-data-configs:
      persistentVolumeClaim:
        claimName: 'my-pv-claim1'
    # Dashboard Icons
    app-data-icons:
      # Example direct NFS mount without need for PV
      nfs:
        server: 'fileserver'
        path: '/srv/homarr/icons'
    # DB files — a PVC is provisioned by default (see below)
    data:
      persistentVolumeClaim:
        claimName: 'homarr-data'

By default a PersistentVolumeClaim is provisioned for data; emptyDir: {} is used for the other two unless overridden in your values.yaml.

persistentVolumeClaims:
  # Default PV is for 'data' where the SQlite database exists
  data:
    accessMode: 'ReadWriteOnce'
    requestStorage: '1Gi'
    storageClassName: 'manual'
    # volumeName: 'existing-pv-name'  # optional: bind this PVC to a specific pre-existing PV
    selector:
      matchLabels:
        type: 'local'

Ingress

Ingress is enabled by default and Homarr is served from the root path (/). Override host and TLS as needed:

ingress:
  enabled: true
  host: 'example.com'
  path: '/'
  tls:
    # Your TLS settings...

Advanced

Other supported deployment configuration include deployment.nodeSelector, deployment.tolerations, and deployment.affinity

You can also adjust container ports, environment variables (such as adding PGID and PUID) and define a serviceAccount.

Have a look at the parent charts default values.yaml for a comprehensive list of available config.

Upgrading

To upgrade the deployment:

helm upgrade homarr media-servarr/homarr -f myvalues.yaml

Uninstallation

To uninstall/delete the homarr deployment:

helm uninstall homarr

Support

For support, issues, or feature requests, please file an issue on the chart’s repository issue tracker.

This site is open source. Improve this page.