Deploying ToolJet on Heroku

<iframe width="800" height="500" src="https://www.youtube.com/embed/ApDtwE1OXY0" frameborder="0" allowfullscreen width="100%"></iframe>

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

Follow the steps below to deploy ToolJet on Heroku:

1. Click the button below to start one click deployment.

   <div style={{textAlign: 'center'}}>
   </div>

2. On Heroku tab, you'll be asked to provide an App name and Choose a region. Enter the name for your deployment and select the region according to your choice.

<div style={{textAlign: 'center'}}> </div>

3. Now let's enter the Config vars to configure additional environment variables that are required for the installation.

   • LOCKBOX_MASTER_KEY: ToolJet server uses lockbox to encrypt datasource credentials. You should set the environment variable LOCKBOX_MASTER_KEY with a 32 byte hexadecimal string. If you have OpenSSL installed, you can run the command openssl rand -hex 32 to generate the key.
   • NODE_ENV: By default NODE_ENV is set to production.
   • NODE_OPTIONS: Node options are configured to increase node memory to support app build.
   • SECRET_KEY_BASE: ToolJet server uses a secure 64 byte hexadecimal string to encrypt session cookies. You should set the environment variable SECRET_KEY_BASE. If you have OpenSSL installed, you can run the command openssl rand -hex 64 to generate the key.
   • TOOLJET_HOST: Public URL of ToolJet installation. This is usually https://<app-name-in-first-step\>.herokuapp.com.
   • TOOLJET_SERVER_URL: URL of ToolJet server installation. (This is same as the TOOLJET_HOST for Heroku deployments)

4. Click on Deploy app button at the bottom to initiate the build.

5. After the successful build, you'll see two buttons at the bottom: Manage App and View. Click on the View to open the app or click on Manage App to configure any settings.

<div style={{textAlign: 'center'}}> </div>

6. The default username of the admin is [email protected] and the password is password.

<div style={{textAlign: 'center'}}> </div>

:::tip The one click deployment will create a free dyno and a free postgresql database. :::

:::tip ToolJet server and client can be deployed as standalone applications. If you do not want to deploy the client on Heroku, modify package.json accordingly. We have a guide on deploying ToolJet client using services such as Firebase. :::

Upgrading to the Latest Version

The latest version includes architectural changes and, hence, comes with new migrations.

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 Version:

• It is crucial to perform a comprehensive backup of your database before starting the upgrade process to prevent data loss.

• Ensure that your current version is v2.23.0-ee2.10.2 before upgrading.

• Users on versions earlier than v2.23.0-ee2.10.2 must first upgrade to this version before proceeding to the latest version.

For specific issues or questions, refer to our Slack.