Elgato_dark/ToolJet
1
0
Fork 0
mirror of https://github.com/ToolJet/ToolJet synced 2026-04-21 21:47:17 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 7
ToolJet/docs/versioned_docs/version-3.16.0-LTS/setup/tooljet-subpath.md
Adish M df311eeb03
Enhance ToolJet deployment documentation for version 3.16.0-LTS (#14896) 
* Enhance ToolJet deployment documentation for version 3.16.0-LTS

- Updated Google Cloud Run setup to clarify architecture and environment variables.
- Improved Kubernetes setup documentation for AKS, EKS, GKE, and general Kubernetes, emphasizing the need for two separate PostgreSQL databases.
- Revised OpenShift deployment instructions to include detailed environment variable configurations and deployment steps.
- Added system requirements for PostgreSQL and Redis, specifying recommended versions and minimum specifications.
- Included warnings about database naming conflicts and critical configurations for successful deployment.

* Enhance upgrade documentation for ToolJet LTS version

- Added critical backup reminder for PostgreSQL instance before upgrading.
- Clarified database requirements, emphasizing the need for two separate database names (PG_DB and TOOLJET_DB).
- Included deployment flexibility options for database hosting.
- Updated installation notes to specify that the upgrade guide is only for existing installations.
- Improved formatting and clarity in various setup guides (Azure, DigitalOcean, Docker, ECS, Google Cloud Run, Kubernetes, OpenShift).

* Enhance deployment documentation for ToolJet on various platforms, including AWS AMI, Azure Container Apps, AWS ECS, Google Cloud Run, Kubernetes (AKS, EKS, GKE), and Openshift. Updated warnings and notes regarding PostgreSQL database setup and ToolJet AI features.

* Enhance deployment documentation for ToolJet LTS version 3.16.0 by updating backup instructions, removing redundant version requirements, and clarifying Redis configuration for external instances.

* Refine deployment documentation for ToolJet by removing redundant environment variable references and adding notes on securing Redis passwords across various platforms including AWS AMI, Docker, Google Cloud Run, Kubernetes (AKS, EKS, GKE), and OpenShift.

* Refine Redis configuration instructions in AWS AMI deployment documentation for clarity and formatting consistency.

* Add new environment variables for bulk upload limits in deployment documentation

* Refine deployment documentation for ToolJet subpath installation by improving environment variable formatting and clarifying upgrade prerequisites.

* Update PostgreSQL database links in deployment documentation for consistency across ECS, Helm, Kubernetes (AKS, EKS, GKE), and OpenShift setups.

* Remove warning about whitelisting ToolJet AI features from Helm deployment documentation

* Refine environment variable configuration for workflow scheduling in Helm deployment documentation

* formatting updates till gke

* final formatting updates

---------

Co-authored-by: rudrapratik30 <pratik104agrawal@gmail.com>
2026-01-16 14:10:34 +05:30

2.5 KiB
Raw Blame History

id title
tooljet-subpath Deploying ToolJet on a Subpath

ToolJet can now be deployed at a subpath rather than the root (/) of a public domain. Example subpath installation URL: http://www.yourcompany.com/apps/tooljet

You'll need to setup the following environment variables if ToolJet installation is on a domain subpath:

TOOLJET_HOST=https://www.yourcompany.com
SUB_PATH=/apps/tooljet/

Environment Variable Details:

  • TOOLJET_HOST: The public URL of your domain (e.g., https://www.yourcompany.com)
  • SUB_PATH: The subpath where ToolJet will be accessible. Must include trailing / and is applicable only when the server is serving the frontend client (e.g., /apps/tooljet/)

For additional environment variables, refer to our Environment Variables documentation.

Upgrading to the Latest LTS Version

:::info If this is a new installation of the application, you may start directly with the latest version. This upgrade guide is only for existing installations. :::

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.

Prerequisites for Upgrading

:::warning Critical: Backup Your PostgreSQL Instance

Before starting the upgrade process, perform a comprehensive backup of your PostgreSQL instance to prevent data loss. Your backup must include both required databases:

  1. PG_DB (Application Database) - Contains users, apps, and configurations
  2. TOOLJET_DB (Internal Database) - Contains ToolJet Database feature data

Ensure both databases are included in your backup before proceeding with the upgrade. :::

  • Users on versions earlier than v2.23.0-ee2.10.2 must first upgrade to this version before proceeding to the latest LTS version.
  • ToolJet 3.0+ Requirement: Deploying ToolJet Database is mandatory from ToolJet 3.0 onwards. For information about breaking changes, see the ToolJet 3.0 Migration Guide.

---

Need Help?