> ## Documentation Index
> Fetch the complete documentation index at: https://docs.enterprise.falkordb.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Installer reference

> Command-line options and environment variables for install.sh and uninstall.sh.

`scripts/install.sh` installs or updates FalkorDB Enterprise on any Kubernetes cluster reachable by `kubectl`. It prints an install plan and asks for confirmation before changing the cluster.

```bash theme={null}
curl -fsSL https://raw.githubusercontent.com/FalkorDB/FalkorDB-Enterprise/refs/heads/main/scripts/install.sh | bash
```

<Note>
  Every long option has an environment variable equivalent in uppercase with underscores. For example, `--kube-context` maps to `KUBE_CONTEXT` and `--namespace` maps to `NAMESPACE`.
</Note>

## Release and namespace options

| Option                        | Default                 | Description                      |
| ----------------------------- | ----------------------- | -------------------------------- |
| `--release NAME`              | `falkordb-enterprise`   | Helm release name.               |
| `--namespace NAME`            | `falkordb-system`       | FalkorDB Enterprise namespace.   |
| `--kube-context NAME`         | current context         | kubeconfig context to target.    |
| `--kubeblocks-namespace NAME` | `kb-system`             | KubeBlocks namespace.            |
| `--kubeblocks-release NAME`   | `kubeblocks`            | KubeBlocks Helm release name.    |
| `--kubeblocks-chart REF`      | `kubeblocks/kubeblocks` | KubeBlocks Helm chart reference. |

## Chart options

| Option                          | Default                                                                                | Description                                                                           |
| ------------------------------- | -------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------- |
| `--chart REF`                   | local checkout, otherwise `oci://registry.falkordb.cloud/falkordb/falkordb-enterprise` | Helm chart path or reference.                                                         |
| `--chart-version VERSION`       | latest                                                                                 | Chart version when installing from a repository or OCI registry.                      |
| `--kubeblocks-version VERSION`  | auto-detected                                                                          | KubeBlocks CRD version. Detected from the chart when omitted.                         |
| `--snapshotter-version VERSION` | `v6.3.3`                                                                               | External snapshotter CRD version.                                                     |
| `-f`, `--values FILE`           | —                                                                                      | Helm values file. Repeatable.                                                         |
| `--set KEY=VALUE`               | —                                                                                      | Helm `--set` override. Repeatable.                                                    |
| `--set-string KEY=VALUE`        | —                                                                                      | Helm `--set-string` override. Repeatable.                                             |
| `--helm-arg VALUE`              | —                                                                                      | Raw argument appended to the Enterprise `helm install`/`upgrade` command. Repeatable. |

## Secrets and registry options

| Option                      | Default                         | Description                                                                    |
| --------------------------- | ------------------------------- | ------------------------------------------------------------------------------ |
| `--jwt-secret VALUE`        | generated                       | Admin Server JWT secret. Generated on first install when omitted.              |
| `--image-pull-secret NAME`  | `falkordb-registry-pull-secret` | Image pull Secret to create or reuse.                                          |
| `--registry-server URL`     | `registry.falkordb.cloud`       | Registry server for the image pull Secret.                                     |
| `--registry-username NAME`  | —                               | Registry username.                                                             |
| `--registry-password VALUE` | —                               | Registry password or token.                                                    |
| `--image-registry HOST`     | `registry.falkordb.cloud`       | Registry for the Admin Server and Admin UI images. Empty keeps chart defaults. |

<Warning>
  Prefer environment variables over inline flags for credentials so secrets do not land in your shell history. For example: `JWT_SECRET='...' REGISTRY_PASSWORD='...' bash scripts/install.sh`.
</Warning>

## Platform dependency options

| Option                       | Description                                                      |
| ---------------------------- | ---------------------------------------------------------------- |
| `--skip-crds`                | Do not apply KubeBlocks CRDs.                                    |
| `--install-snapshot-crds`    | Pre-apply VolumeSnapshot CRDs and disable chart CRD ownership.   |
| `--skip-kubeblocks`          | Do not install or upgrade the KubeBlocks Helm release.           |
| `--skip-snapshot-controller` | Do not install or upgrade the Snapshot Controller Helm release.  |
| `--skip-dependency-update`   | Do not run `helm dependency update` for local chart directories. |

## Networking options

| Option         | Description                                                                                                                                                 |
| -------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `--no-ingress` | Expose the Admin UI and Admin Server with two `LoadBalancer` services instead of a single gateway Ingress. Also sets `adminServer.env.cookieSameSite=none`. |

## Execution options

| Option                 | Default | Description                                                         |
| ---------------------- | ------- | ------------------------------------------------------------------- |
| `--timeout DURATION`   | `15m`   | Helm and `kubectl wait` timeout.                                    |
| `--skip-auth-check`    | `false` | Do not verify Kubernetes RBAC permissions before installing.        |
| `--no-wait`            | —       | Do not wait for Helm resources.                                     |
| `--no-enterprise-wait` | —       | Do not wait for the FalkorDB Enterprise Helm release.               |
| `--dry-run`            | `false` | Render and validate Helm output without changing cluster resources. |
| `-y`, `--yes`          | `false` | Skip confirmation prompts.                                          |
| `--debug`              | `false` | Enable shell tracing and Helm debug output.                         |
| `-h`, `--help`         | —       | Show the built-in help text.                                        |

## Examples

<CodeGroup>
  ```bash Non-interactive install theme={null}
  curl -fsSL https://raw.githubusercontent.com/FalkorDB/FalkorDB-Enterprise/refs/heads/main/scripts/install.sh | \
    bash -s -- --yes
  ```

  ```bash Target a specific context theme={null}
  curl -fsSL https://raw.githubusercontent.com/FalkorDB/FalkorDB-Enterprise/refs/heads/main/scripts/install.sh | \
    bash -s -- \
      --kube-context my-cluster \
      --namespace falkordb-system \
      --kubeblocks-namespace kb-system
  ```

  ```bash Production values file theme={null}
  JWT_SECRET="$(openssl rand -hex 32)" \
    bash scripts/install.sh \
      --kube-context production-cluster \
      --values production-values.yaml \
      --yes
  ```

  ```bash Dry run theme={null}
  bash scripts/install.sh --dry-run --chart helm/falkordb-enterprise
  ```
</CodeGroup>

## Uninstall

`scripts/uninstall.sh` removes the Enterprise release and, optionally, the platform components the installer added. See the [uninstall playbook](/upgrades/uninstall) for the full procedure and data-retention considerations.

## Source of truth

The installer help text is authoritative. Run it locally to see the exact options for your version:

```bash theme={null}
bash scripts/install.sh --help
```