Skip to main content
Version: 3.0.0-LTS

DigitalOcean

Follow the steps below to deploy ToolJet on a DigitalOcean Droplet.

1. Navigate to the Droplets section in DigitalOcean.

create a Droplet

2. Configure the Droplet with the following options:

  • Image: Ubuntu
  • Plan: Choose a plan (e.g., Basic, 4GB RAM, 2 vCPU)
use a droplet plan
  • Auth: For authentication, use password or ssh
  • Click Create Droplet and note the assigned public IP

3. Create a Firewall for the Droplets to allow required ports.

protocolportallowed_cidr
tcp22your IP
tcp800.0.0.0/0
tcp4430.0.0.0/0

4. Connect to the Droplets via SSH.

5. Install Docker and Docker Compose using the following commands:

apt update && apt upgrade -y
apt install -y docker.io

Enable and start Docker:

systemctl enable docker 
systemctl start docker

Install Docker Compose:

apt install -y curl 
curl -SL https://github.com/docker/compose/releases/latest/download/docker-compose-linux-x86_64 -o /usr/local/bin/docker-compose
chmod +x /usr/local/bin/docker-compose

Verify installation:

docker --version 
docker-compose --version

6. Update the TOOLJET_HOST in the .env file:

TOOLJET_HOST=http://<public_ip>:80

7. Use the Docker Documentation to deploy ToolJet.

warning

To enable ToolJet AI features in your ToolJet deployment, whitelist api-gateway.tooljet.ai and docs.tooljet.ai.

Setup to Enable ToolJet AI

Build applications effortlessly with ToolJet AI, using natural language to generate and customize apps. Refer to ToolJet AI guide for more information.

Follow this guide to enable AI features in your self-hosted setup.

Deployment Steps

  1. Add Chroma under the services section and define volumes under the volumes section in the docker-compose.
services:
chroma:
name: chromadb
image: chromadb/chroma
ports:
- "8000:8000"
environment:
- CHROMA_HOST_PORT=8000
volumes:
- chromadb_data:/chroma

volumes:
chromadb_data:
driver: local
  1. Add these environment variables to the .env file in the ToolJet server. CHROMA_DB_URL=chromadb:8000
    AI_GATEWAY_URL=https://api-gateway.tooljet.ai

Upgrading to the Latest LTS Version

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 page. The LTS tags follow a naming convention with the prefix LTS- followed by the version number, for example tooljet/tooljet:ee-lts-latest.

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.

Note: For existing user wants to upgrade, would require to add chromadb along with the existing setup.

If you have any questions feel free to join our Slack Community or send us an email at [email protected].