Skip to content

Basic Installation: Helm

The basic installation includes only Detect and Match modules and does not support the Liveness and Identification features. To use these functionalities, see the Advanced Installation guide.

Add Chart

First of all, you need to add the regulaforensics chart:

helm repo add regulaforensics
helm repo update

See the helm repo for command documentation.


  • At least 3 GB of RAM available on your cluster per pod's worker
  • Helm 3
  • PV provisioner support in the underlying infrastructure (essential for storing logs)

Installing the Chart


To install the chart, you need to obtain the regula.license file (at the Client Portal, for example) and then create a Kubernetes Secret from that license file:

kubectl create secret generic face-api-license --from-file=regula.license

Note that the regula.license file should be located in the same folder where the kubectl create secret command is executed.

Detect and Match

To install the chart with the release name my-release and Detect and Match capabilities (default), invoke:

helm install my-release regulaforensics/faceapi --set licenseSecretName=face-api-license

Uninstalling Chart

To uninstall/delete the my-release deployment, run:

helm uninstall my-release

The command removes all the Kubernetes components associated with the chart and deletes the release.


You can find the Helm Chart settings at the helm repo.

To change multiple configurations, download and use the values.yaml file.