Skip to main content
Version: 3.1.0-Beta 🚧

Deploying ToolJet on Amazon EC2

info

You should setup a PostgreSQL database manually to be used by the ToolJet server.

You can effortlessly deploy Amazon Elastic Compute Cloud Service (EC2) by utilizing a CloudFormation template. This template will deploy all the services required to run ToolJet on AWS EC2 instances.

To deploy all the services at once, simply employ the following template:

curl -LO https://tooljet-deployments.s3.us-west-1.amazonaws.com/cloudformation/EC2-cloudfomration.yml

Follow the steps below to deploy ToolJet on AWS EC2 instances.

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

  2. Login to your AWS management console and go to the EC2 management page.

  3. Under the Images section, click on the AMIs button.

  4. Find the ToolJet version you want to deploy. Now, from the AMI search page, select the search type as "Public Images" and input the version you'd want AMI Name : tooljet_vX.X.X.ubuntu_bionic in the search bar.

  5. Select ToolJet's AMI and bootup an EC2 instance.
    Creating a new security group is recommended. For example, if the installation should receive traffic from the internet, the inbound rules of the security group should look like this:

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

  6. Once the instance boots up, SSH into the instance by running ssh -i <path_to_pem_file> ubuntu@<public_ip_of_the_instance>.

  7. Switch to the app directory by running cd ~/app.
    Modify the contents of the .env file. ( Eg: vim .env )

    The default .env file looks like this:

    LOCKBOX_MASTER_KEY=
    SECRET_KEY_BASE=
    PG_DB=
    PG_USER=
    PG_HOST=
    PG_PASS=
    TOOLJET_DB=
    TOOLJET_DB_HOST=
    TOOLJET_DB_USER=
    TOOLJET_DB_PASS=

    Read environment variables reference

    info

    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.

  8. TOOLJET_DB_HOST environment variable determines where you can access the ToolJet client. It can either be the public ipv4 address of your instance or a custom domain that you want to use.

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

    info

    We use a lets encrypt plugin on top of nginx to create TLS certificates on the fly.

    info

    Please make sure that TOOLJET_DB_HOST starts with either http:// or https://

  9. Once you've configured the .env file, run ./setup_app. This script will install all the dependencies of ToolJet and then will start the required services.

  10. 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 EC2 instance.

  11. You're all done, ToolJet client would now be served at the value you've set in TOOLJET_HOST.

Deploying ToolJet Database​

ToolJet AMI comes inbuilt with PostgREST. If you intend to use this feature, you'd only have to setup the environment variables in ~/app/.env file and run ./setup_app script.

You can learn more about this feature here.

Workflows​

ToolJet Workflows allows users to design and execute complex, data-centric automations using a visual, node-based interface. This feature enhances ToolJet's functionality beyond building secure internal tools, enabling developers to automate complex business processes.

Enabling Scheduling​

To activate workflows scheduling, set the following environment variables:

WORKFLOW_WORKER=true
ENABLE_WORKFLOW_SCHEDULING=true
TOOLJET_WORKFLOWS_TEMPORAL_NAMESPACE=default
TEMPORAL_SERVER_ADDRESS=<Temporal_Server_Address>

Note: Workflows scheduling requires a Temporal server to be deployed. Restarting the server using ./setup_app.

Deploying Temporal with Docker Compose​

Below is a docker-compose template to set up Temporal.

curl -LO https://tooljet-deployments.s3.us-west-1.amazonaws.com/pre-release/ec2-temporal/docker-compose.yml

This setup can be deployed on a different EC2 instance. To enable seamless communication, ensure that both the application server and the Temporal server are in the same VPC.

Note: Ensure that port 7233 is configured for gRPC in the security group.

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.

Note: 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.

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