This project provides a Helm chart for deploying HomeBox: the inventory and organization system built for the Home User into any Kubernetes cluster. It integrates the official Docker images built by the HomeBox team and hosted on DockerHub. It also includes PostgreSQL server that use the Bitnami charts, but it is easy to provide your own.

The charts are built and then published to these project GitHub Pages, allowing anyone to quickly deploy and test the application.

• HomeBox Helm Chart
  • 1.1. Prerequisite
  • 1.2. Configure the application
    • 1.2.1. Use an external PostgreSQL server
  • 1.3. Install the application
    • 1.3.1. Add the GitHub Helm repository (optional)
    • 1.3.2. Install the chart
      • 1.3.2.1. Install a specific version of HomeBox
    • 1.3.3. Verify the deployment
  • 1.4. Uninstall the application
  • 1.5. License
  • 1.6. Contact

• A Kubernetes cluster,
• A PostgreSQL server (optional),
• The Helm client installed locally (see Quickstart Guide),
• The kubectl command-line tool installed locally (optionnal, see Install Tools)

back to top

Like any other Helm chart, the available configuration options can be found in the chart/values.yaml configuration file. I recommend you to override any values in a dedicated homebox.values.yaml file before deploying the chart:

1. Start by retrieving the chart default values: helm show values chart > homebox.values.yaml

2. Edit the homebox.values.yaml values, and specially the following ones:

   env:
     HBOX_DATABASE_DRIVER: postgres
   
   # For more information checkout: https://artifacthub.io/packages/helm/bitnami/postgresql
   postgresql:
     enabled: true
     auth:
       username: homebox-user
       password: homebox-password
       database: homebox-db
   
   ingress:
     enabled: true
     hosts:
       - host: homebox.domain.tld
         paths:
           - path: /
             pathType: ImplementationSpecific

By default, the chart deploys a PostgreSQL server via a subchart dependency. However, if want to use your own instance, you can set the following values:

postgresql:
  enabled: false
externalPostgresql:
  host: postgres.domain.tld
  port: 5432
  auth:
    username: external-homebox-user
    password: external-homebox-password
    database: external-homebox-db

back to top

To deploy the application using Helm, follow these steps:

helm repo add homebox https://bythehugo.github.io/homebox-helm/
helm repo update

helm upgrade --install homebox homebox/homebox -f homebox.values.yaml

You can also install the chart directly from sources:

helm upgrade --install homebox chart -f homebox.values.yaml

If you want to install a specific version of HomeBox, you must define the .image.tag key in the values.yaml file or directly inline:

helm upgrade --install --set "image.tag=0.19.0" homebox homebox/homebox

kubectl get all -l app=homebox

Replace with your target namespace if you specified one.

back to top

To uninstall the Helm chart and remove all associated resources from your Kubernetes cluster, follow these steps:

1. Identify the release name you used when installing the chart. If you haven't changed the release name, it may be the default or the one you specified during installation.

2. Run the following command to uninstall the release:

   helm uninstall homebox

3. Verify that the resources have been removed:

   kubectl get all -l app=homebox

   This should return no resources related to the uninstalled release.

Note: If you used custom namespaces during installation, include the -n <namespace> flag in the commands:

helm uninstall homebox -n <namespace>
kubectl get all -n <namespace> -l app=homebox

back to top

Distributed under the Apache 2.0 License. See LICENSE for more information.

back to top

Hugo CHUPIN - hugo@chupin.xyz - hugo.chupin.xyz - @hugo.chupin.xyz

Project link: https://github.com/ByTheHugo/homebox-helm

back to top