Deploying ToolJet using Docker Compose

Follow the steps below to deploy ToolJet on a server using Docker Compose. ToolJet requires a PostgreSQL database to store applications definitions, (encrypted) credentials for datasources and user authentication data.

info

If you rather want to try out ToolJet on your local machine with Docker, you can follow the steps here.

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

Installing Docker and Docker Compose

Install docker and docker-compose on the server.

• Docs for Docker Installation
• Docs for Docker Compose Installation

Deployment options

There are two options to deploy ToolJet using Docker Compose:

1. With in-built PostgreSQL database (recommended). This setup uses the official Docker image of PostgreSQL.
2. With external PostgreSQL database. This setup is recommended if you want to use a managed PostgreSQL service such as AWS RDS or Google Cloud SQL.

Confused about which setup to select? Feel free to ask the community via Slack: https://tooljet.com/slack.

With in-built PostgreSQL

1. Download our production docker-compose file into the server.

   curl -LO https://raw.githubusercontent.com/ToolJet/ToolJet/main/deploy/docker/docker-compose-db.yaml
   mv docker-compose-db.yaml docker-compose.yaml
   mkdir postgres_data

2. Create .env file in the current directory (where the docker-compose.yaml file is downloaded as in step 1):

   curl -LO https://raw.githubusercontent.com/ToolJet/ToolJet/main/deploy/docker/.env.internal.example
   curl -LO https://raw.githubusercontent.com/ToolJet/ToolJet/main/deploy/docker/internal.sh && chmod +x internal.sh
   mv .env.internal.example .env && ./internal.sh

3. To start the docker container, use the following command:

   docker-compose up -d

4. (Optional) TOOLJET_HOST environment variable can either be the public ipv4 address of your server or a custom domain that you want to use. Which can be modified in the .env file.

   Also, for setting up additional environment variables in the .env file, please check our documentation on environment variable

   Examples: TOOLJET_HOST=http://12.34.56.78 or TOOLJET_HOST=https://tooljet.yourdomain.com

   If you've set a custom domain for TOOLJET_HOST, add a A record entry in your DNS settings to point to the IP address of the server.

   info

   i. Please make sure that TOOLJET_HOST starts with either http:// or https://

   ii. Setup docker to run without root privileges by following the instructions written here https://docs.docker.com/engine/install/linux-postinstall/

   iii. If you're running on a linux server, docker might need sudo permissions. In that case you can either run: sudo docker-compose up -d

With external PostgreSQL

1. Setup a PostgreSQL database and make sure that the database is accessible.

2. Download our production docker-compose file into the server.

   curl -LO https://raw.githubusercontent.com/ToolJet/ToolJet/main/deploy/docker/docker-compose.yaml

3. Create .env file in the current directory (where the docker-compose.yaml file is downloaded as in step 1):

   Kindly set the postgresql database credentials according to your external database. Please enter the database details with the help of the bash as shown below.

   

   curl -LO https://raw.githubusercontent.com/ToolJet/ToolJet/main/deploy/docker/.env.external.example
   curl -LO https://raw.githubusercontent.com/ToolJet/ToolJet/main/deploy/docker/external.sh && chmod +x external.sh
   mv .env.external.example .env && ./external.sh

4. To start the docker container, use the following command:

   docker-compose up -d

5. (Optional) TOOLJET_HOST environment variable can either be the public ipv4 address of your server or a custom domain that you want to use. Which can be modified in the .env file.

   Also, for setting up additional environment variables in the .env file, please check our documentation on environment variable

   Examples: TOOLJET_HOST=http://12.34.56.78 or TOOLJET_HOST=https://tooljet.yourdomain.com

   If you've set a custom domain for TOOLJET_HOST, add a A record entry in your DNS settings to point to the IP address of the server.

   info

   i. Please make sure that TOOLJET_HOST starts with either http:// or https://

   ii. If there are self signed HTTPS endpoints that Tooljet needs to connect to, please make sure that NODE_EXTRA_CA_CERTS environment variable is set to the absolute path containing the certificates.

   iii. If you're running a linux server, docker might need sudo permissions. In that case you can either run: sudo docker-compose up -d

   iv. Setup docker to run without root privileges by following the instructions written here https://docs.docker.com/engine/install/linux-postinstall/