Back to all templates
ToolJet logo

ToolJet

Development1024MB+ RAM

Open-source low-code platform for building internal tools

nocodelow-codeinternal-toolsretool-alternative

Deploy ToolJet in 3 Steps

1

Connect Your VPS

Add your server credentials to Server Compass

2

Select ToolJet

Choose from our template library

3

Deploy & Configure

Fill in settings and click Deploy

No Docker knowledge required
Step-by-step deployment guide

Deploy ToolJet on a VPS with Server Compass

Use the ToolJet template in Server Compass to deploy a self-hosted internal tool builder with Postgres on your VPS, then verify the ToolJet web UI in a browser.

About 7 minutesBrowser verified
1
Step 1

Open the server Apps tab

Select your VPS, open the Apps tab, and start a new app deployment. Keep sensitive server details hidden before capturing or sharing screenshots.

Server Compass Apps tab before creating a ToolJet app
2
Step 2

Choose an app template

Click New App and choose the template deployment path so Server Compass can load the built-in catalog.

Choosing to deploy an app from a Server Compass template
3
Step 3

Search for ToolJet

Use the template picker search to find ToolJet in the Server Compass template catalog.

Searching for ToolJet in the Server Compass template picker
4
Step 4

Select the ToolJet template

Choose the ToolJet template. Server Compass fills the ToolJet web service, lockbox master key, session secret, Postgres database, database user, and database password.

ToolJet template selected in Server Compass
5
Step 5

Review the ToolJet settings

Confirm the app name and compose services. In this run, the app was named tooljet-demo and used host port 3000.

Reviewing ToolJet project settings and compose services
6
Step 6

Deploy ToolJet

Review the generated environment values, confirm the port is available, and click Deploy Now.

Reviewing ToolJet environment variables and port before deployment
7
Step 7

Watch the deployment progress

Keep the deployment modal open while Server Compass uploads the compose file, pulls the ToolJet image, starts the container, and verifies the stack.

Server Compass deploying the ToolJet template on the VPS
8
Step 8

Confirm ToolJet is running

After deployment finishes, return to the Apps tab and confirm the ToolJet app is marked Running with its application URL available.

ToolJet template running in the Server Compass Apps tab
9
Step 9

Open ToolJet in the browser

Open the application URL in a browser. The ToolJet web UI confirms the stack is reachable.

The deployed ToolJet web UI loaded in a browser

After ToolJet Opens

  • Create the first ToolJet admin account before production use.
  • Configure HTTPS, workspace permissions, SMTP, datasource credentials, and app builder settings before production use.
  • Add a domain and HTTPS before exposing ToolJet to users.
  • Back up the Postgres volume before relying on it for production internal tools.

Verified Result

The ToolJet web UI loaded successfully in a browser.

ToolJet deployment questions

What does the ToolJet template deploy?

It deploys ToolJet with a Postgres database service.

Which port did the tutorial use?

The tutorial verified ToolJet on host port 3000, which maps to the ToolJet web service on container port 80.

Why does the guide stop at the first-run web UI?

The tutorial verifies the clean ToolJet first-run web UI because admin setup, apps, datasources, and external integrations depend on the production server.

Should this become a blog post?

No. The deployment guide should live on the ToolJet template detail page and be linked from the reusable template deployment docs page.

CLI Deployment

Deploy ToolJet Yourself

Want full control? Here's how to deploy ToolJet yourself using Docker Compose.

1

Log into Your Server

Access your server's command line by opening a terminal and running the SSH command below.

terminal
# SSH into your server
ssh root@your-server-ip

# Using a custom SSH key
ssh -i ~/.ssh/id_rsa root@your-server-ip

First time? Need Docker? Install it: curl -fsSL https://get.docker.com | sh

2

Prepare the Install Location

Set up the folder structure for your Docker deployment.

terminal
# Create and navigate to project directory
mkdir -p ~/apps/tooljet
cd ~/apps/tooljet
3

Create docker-compose.yml

Set up your Docker Compose file with this configuration:

docker-compose.yml
services:
  tooljet:
    image: tooljet/tooljet:ee-lts-latest
    tty: true
    stdin_open: true
    ports:
      - "80:80"
    environment:
      - SERVE_CLIENT=true
      - PORT=80
      - TOOLJET_HOST=http://localhost:80
      - LOCKBOX_MASTER_KEY=<your-lockbox-master-key>
      - SECRET_KEY_BASE=<your-secret-key-base>
      - PG_HOST=db
      - PG_PORT=5432
      - PG_USER=tooljet
      - PG_PASS=<your-db-password>
      - PG_DB=tooljet
      - ENABLE_TOOLJET_DB=true
      - TOOLJET_DB=tooljet_db
      - TOOLJET_DB_HOST=db
      - TOOLJET_DB_PORT=5432
      - TOOLJET_DB_USER=tooljet
      - TOOLJET_DB_PASS=<your-db-password>
    command: npm run start:prod
    restart: always
    depends_on:
      db:
        condition: service_healthy

  db:
    image: postgres:16-alpine
    environment:
      - POSTGRES_DB=tooljet
      - POSTGRES_USER=tooljet
      - POSTGRES_PASSWORD=<your-db-password>
    volumes:
      - postgres_data:/var/lib/postgresql/data
    restart: always
    healthcheck:
      test: ["CMD-SHELL", "pg_isready -U tooljet -d tooljet"]
      interval: 10s
      timeout: 5s
      retries: 5
      start_period: 30s

volumes:
  postgres_data:
Required Settings
PORTHost port to expose(default: 80)
LOCKBOX_MASTER_KEYLockbox master key (32 bytes hex)
SECRET_KEY_BASESecret key base (64 bytes hex)
DB_NAMEDatabase name(default: tooljet)
DB_USERDatabase user(default: tooljet)
DB_PASSWORDDatabase password
4

Run the Deployment

Start all services defined in your compose file.

terminal
# Start the containers in detached mode
docker compose up -d

# Check if containers are running
docker compose ps

# View logs
docker compose logs -f
5

Configure Network Access

Open the port so you can access the application externally.

terminal
# Allow the application port through firewall
sudo ufw allow 80/tcp
sudo ufw reload

# Access your app at:
# http://your-server-ip:80
Skip the Terminal

Want one-click deploys? Try Server Compass.

Skip the terminal and deploy ToolJet with a visual interface. Configure everything with clicks, not commands.

  • Visual configuration UI
  • One-click deployment
  • Automatic SSL setup
  • Zero-downtime updates
  • Built-in monitoring
  • One-click rollbacks
Download Server Compass$29 one-time • Lifetime license

After Deployment

After deploying ToolJet with Server Compass, complete these steps to finish setup

1

Create your workspace and admin account

2

Create your first application

Need help? Check out our documentation for detailed guides.

ToolJet FAQ

Common questions about self-hosting ToolJet

How do I deploy ToolJet with Server Compass?

Simply download Server Compass, connect to your VPS, and select ToolJet from the templates list. Fill in the required configuration and click Deploy. The entire process takes under 3 minutes.

What are the system requirements for ToolJet?

ToolJet requires a minimum of 1024MB RAM. We recommend a VPS with at least 2048MB RAM for optimal performance. Any modern Linux server with Docker support will work.

Can I migrate my existing ToolJet data?

Yes! Server Compass provides volume mapping that allows you to import existing data. You can also use standard ToolJet backup and restore procedures.

How do I update ToolJet to the latest version?

Server Compass makes updates easy. Simply click the Update button in your deployment dashboard, and the latest ToolJet image will be pulled and deployed with zero downtime.

Is ToolJet free to self-host?

ToolJet is open-source software. You only pay for your VPS hosting (typically $5-20/month) and optionally Server Compass ($29 one-time). No subscription fees or per-seat pricing.

Ready to Self-Host ToolJet?

Download Server Compass and deploy ToolJet to your VPS in under 3 minutes. No Docker expertise required.

Download Server Compass