Elgato_dark/ToolJet
1
0
Fork 0
mirror of https://github.com/ToolJet/ToolJet synced 2026-04-22 22:17:55 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 8
ToolJet/docs/versioned_docs/version-1.x.x/setup/heroku.md
Karan Rathod b6bf3151a6 update docker setup doc
2024-04-29 17:12:28 +05:30

3.8 KiB
Raw Blame History

id title
heroku Heroku

Deploying ToolJet on Heroku

If you have any questions feel free to join our Slack Community or send us an email at hello@tooljet.com.

Follow the steps below to deploy ToolJet on Heroku:

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

    Deploy

  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.

heroku appname

  1. 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)

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

  3. 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.

heroku build
  1. The default username of the admin is dev@tooljet.io and the password is password.
heroku login

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