2024-11-10 22:27:25 +00:00
---
id: helm
title: Helm
---
# Deploying ToolJet with Helm Chart
This repository contains Helm charts for deploying [ToolJet ](https://github.com/ToolJet/helm-charts ) on a Kubernetes Cluster using Helm v3. The charts include an integrated PostgreSQL server that is enabled by default. However, you have the option to disable it and configure a different PostgreSQL server by updating the `values.yml` file.
## Installation
### From Helm repo
```bash
helm repo add tooljet https://github.com/ToolJet/helm-charts.git
helm install tooljet tooljet/tooljet
```
2024-11-12 10:20:47 +00:00
### From the Source
2024-11-10 22:27:25 +00:00
1. Clone the repository and navigate to this directory
2024-11-12 10:20:47 +00:00
2. Run `helm dependency update`
2024-11-10 22:27:25 +00:00
3. It is recommended but optional to modify the values in the `values.yaml` file, such as usernames, passwords, persistence settings, etc.
4. Run `helm install -n $NAMESPACE --create-namespace $RELEASE .`
Remember to replace the variables with your specific configuration values.
2025-02-11 07:32:43 +00:00
:::warning
To enable ToolJet AI features in your ToolJet deployment, whitelist `api-gateway.tooljet.ai` and `docs.tooljet.ai` .
:::
2024-11-12 10:20:47 +00:00
## ToolJet Database
2024-11-10 22:27:25 +00:00
ToolJet offers a hosted database solution that allows you to build applications quickly and manage your data effortlessly. The ToolJet database requires no setup and provides a user-friendly interface for data management.
2024-11-13 07:32:52 +00:00
For more information about the ToolJet database, you can visit [here ](/docs/tooljet-db/tooljet-database ).
2024-11-10 22:27:25 +00:00
2024-11-12 10:20:47 +00:00
You need to set up and deploy the PostgREST server, which facilitates querying the ToolJet Database.
2024-11-10 22:27:25 +00:00
## Upgrading to the Latest LTS Version
2024-11-12 10:20:47 +00:00
New LTS versions are released every 3-5 months with an end-of-life of atleast 18 months. To check the latest LTS version, visit the [ToolJet Docker Hub ](https://hub.docker.com/r/tooljet/tooljet/tags ) page. The LTS tags follow a naming convention with the prefix `LTS-` followed by the version number, for example `tooljet/tooljet:ee-lts-latest` .
2024-11-10 22:27:25 +00:00
If this is a new installation of the application, you may start directly with the latest version. This guide is not required for new installations.
#### Prerequisites for Upgrading to the Latest LTS Version:
- It is crucial to perform a **comprehensive backup of your database** before starting the upgrade process to prevent data loss.
- Users on versions earlier than **v2.23.0-ee2.10.2** must first upgrade to this version before proceeding to the LTS version.
2025-02-11 07:32:43 +00:00
### Additional Step for Upgrading from v3.0.33-ee-lts to the Latest LTS Version
If you are upgrading from version v3.0.33-ee-lts to the latest LTS, please ensure that the following configuration is done:
Setup ChromaDB Deployment.
*Currently, ChromaDB does not have support for Kubernetes.*
1. To use ChromaDB, you need to set up a VM, deploy ChromaDB on it, and then connect to it for usage.
This service helps to deploy chromadb using docker-compose.
```yml
name: ChromaDB
services:
chroma:
name: chromadb
image: chromadb/chroma
ports:
- "8000:8000"
environment:
- CHROMA_HOST_ADDR=0.0.0.0
- CHROMA_HOST_PORT=8000
volumes:
- chromadb_data:/chroma
volumes:
chromadb_data:
driver: local
```
2. Add these environment variable in the ToolJet deployment file:
```
- name: CHROMA_DB_URL
value: < instance_ip:8000 >
```
```
- name: AI_GATEWAY_URL
value: https://api-gateway.tooljet.ai
```
2024-11-12 10:20:47 +00:00
*If you have any questions feel free to join our [Slack Community ](https://tooljet.com/slack ) or send us an email at hello@tooljet.com.*