9.9 KiB
| id | title |
|---|---|
| multi-environment | Multi-Environment |
Paid feature
Environments in ToolJet help manage different stages of application development, ensuring smooth transitions between development, testing, and production. This guide covers what environments are, their purpose, and how they function in ToolJet.
Environments make it easier to develop and deploy applications without disrupting production. They keep changes isolated, so testing and debugging can happen without affecting live users. Teams can collaborate more efficiently, as different environments allow them to work independently.
What are Environments?
An environment in ToolJet represents a separate configuration space where applications, data sources, and constants can be defined and managed.
By default, ToolJet provides three environments:
-
Development: The Development environment is where application development and initial testing take place. It is a dedicated space for ToolJet developers to build, configure, and experiment with application features. Changes in this environment do not affect live users, allowing for frequent updates and debugging.
-
Staging: The Staging environment acts as a pre-production space where applications undergo thorough testing before deployment. It closely resembles the Production environment and helps ensure that all features, performance, and security aspects function as expected. Teams such as QA and product managers use this environment to validate and approve changes before releasing them to end-users.
-
Production: The Production environment is the final, live version of the application where end users interact with it. This environment is stable and optimized for performance after thorough testing in the Development and Staging environments.
Multi-Environment Support in ToolJet
ToolJet provides environment management across different components:
Applications
Each application has development, staging, and production environments. Developers build the application in the development environment and then move it to staging for testing. Your testing team can review the application in staging, and once it's thoroughly tested, you can promote it to production and release it to your end users.
Data Sources
Data sources can be configured separately for each environment, allowing applications to connect to different databases or APIs depending on the environment. This ensures secure and structured access to relevant data during each stage of development.
Constants
Constants such as API keys, credentials, or other configuration variables can be defined uniquely for each environment. This helps maintain security and prevents misconfigurations across different deployment stages.
Application Life cycle
The application lifecycle in ToolJet involves managing applications across different environments development, staging, and production. You can build the application in development environment and promote it to staging for testing. After testing you can promote it to production and release the app for your end-users.
You can configure data sources and constants for each environment, and ToolJet will automatically use the appropriate ones based on the target environment.
-
Development – Developers build and test the application in the ToolJet app builder.
-
Staging – The testing or product team validates requirements and tests the application using staging data. Apps and queries cannot be edited in this environment.
-
Production – After thorough testing in staging, the application is promoted to production. This can serve as a pre-release environment where you test with production data and constants before releasing the application to end users. Refer to Release documentation to learn more.
Environment Permissions
Environment Access Permission
Admin can configure environment access for user groups or roles from the Granular Access Control page.
Environment access determines the environment the user can access the app, while the user’s application permission (Edit or View) determines what they can do inside that environment.
Final access is decided by both, App Permission (Edit/View) and Environment Access.
| Application Permission | Development Environment | Staging Environment | Production Environment | No Environment |
|---|---|---|---|---|
| Edit | User can access app in development environment and edit the application in Development Environment | User can access app in Staging Environment, run queries and inspect app. | User can access app in Production environment, run queries and inspect. | User can open the app in any environment |
| View | User can preview the app in Development environment but cannot edit the application. | User can preview the application in staging environment only. | User can preview the application in production environment only | User can preview the app in any environment |
Permission Priority
A single group can have multiple permissions assigned for an application and its environments. When this happens, ToolJet combines these permissions, and Edit always takes priority over View.
This means:
- If a group grants both View and Edit permission for an app, the user gets Edit permission.
- If a group grants View permission for multiple environments but Edit for one environment, the user gets Edit permission for the app and access to all specified environments.
- If no environments are specified, the permission applies to all environments by default.
Examples:
The following examples illustrate how different combinations of application permissions, environment access, and role defaults determine a user’s final permissions:
| Scenario | App Permission (Final) | Environment Access (Final) | Development | Staging | Production |
|---|---|---|---|---|---|
| 1. Builder with multiple permissions in same group | Edit (Edit > View) | Staging only (explicitly specified) | - | ✅ Can open + run queries Cannot edit UI/queries |
- |
| 2. Builder + Custom Group with overlapping permissions | Edit (Edit > View) | Union of environments specified: Staging only | - | ✅ Can open + run queries Cannot edit UI/queries |
- |
| 3. Builder (default role) with NO environment specified at all | Edit | All environments (none specified) | ✅ Can edit UI + queries | ✅ Can open + run queries Cannot edit UI/queries |
✅ Can open + run queries Cannot edit UI/queries |
| 4. End User (default) | View | Released app only (default) | - | - | - |
| 5. End User with explicit preview access | View | Development + Staging (explicitly selected) | ✅ Can preview only | ✅ Can preview only | - |
Promote Application Permission
Admin can configure the Promote Application permission from the Permissions page. This disables the Promote button for users who do not have the required permission, allowing only authorized roles, such as team leads, to promote the application from one environment to another.
Version Actions by Environment
Each environment has a different impact on your application. Please refer the following table for details.
| Action | Development | Staging | Production |
|---|---|---|---|
| Edit versions | ✅ (only draft versions) | ❌ | ❌ |
| Rename versions | ✅ (only draft versions) | ❌ | ❌ |
| Delete versions | ✅ | ✅ | ✅ |
| Create new versions | ✅ | ✅ | ✅ |
Checkout the Environment-Example guide to learn about multi-environment in ToolJet with a practical example.