* Initial Structure Setup * Add SMTP Configuration Content * Add ToolJet Plan Content * Update ToolJet Plan Docs * Update SMȚP Configuration * Add Organization Overview * Update SMTP Cofig * add licensing structure * revert AppCard.jsx * revert AppCard.jsx * Revert AppMenu.jsx * Revert Folders.jsx * Revert ManageGroupPermissionResources.jsx * revert mixins.scss * revert tabler.scss * revert tabler.scss * revert tabler.scss * revert tabler.scss * add: white label doc * Update overview * add: instances and workspaces * revert AppCard.jsx * revert changes from EditVersionModal.jsx * Revert Changes * Delete Extra File * fix: comments * update interlink * fix: multiple instance content * tj deployment beta * update tj deployment beta * Update Email Server Beta * Update Overview * update setup email communication * Update Licensing * Update overview and self hosted docs * Update self hosted beta * Update Licensing * minor improvments * update link * Update folder name * minor updates * Update Self Hosted * Update Cloud and Overview * Minor Updates and add Mailgun Screenshot * Change beta folder structure and add sendgrid screenshot * update setup tj folder * Replicate changes to 3.0.0-LTS * Add overview and onboard user structure in beta * Add Overview for User Management and Access Control * Add Invite User * first draft - bulk invite, archive, self signup * update: intance-workspace-whitelabelling * fix: workspace-whitelable doc * minor update in invite user * Update Onboarding and Offboarding of Users - 03/01 * Add structure for authentication and rbac in beta * update super admin file structure * add super admin content * Update overview page * Overview for onboard and offboard user * minor edit overview page * Update Invite User * Update Bulk Invite User * updated archive user * Update onboarding and offboarding * Content Update * Update Super Admin Structure * Update Super Admin * User Roles Content * Custom Groups Content * Granular Access Control [WIP] * Add SSO Structure * github sson 1 * github sso * Google SSO * ldap * grammatical improvement * Feedback Updates 1 * complete RBAC * sso update * SSO LDAP SAML OIDC * OIDC Setup * Google OIDC * Update LDAP and SAML Intro * Update Profile Management Structure * Update Access Control Docs * Update Custom Groups * feat: authentication * OIDC - Okta * feat: cloud auth * fix: overview typo * fix: selfhosted auth titles * Group Sync Structure * User Metadata * [WIP] OIDC Group Sync * OIDC Group Sync * Update use case example in user metadata * Remove password management section * Update reset password * add: retry limit in password login * Docs feedback update * OIDC Group Sync Docs * oidc grp sync * Custom Group * access control * Profile Management Structure * edit user details and reset password * profile settings * Development Lifecycle Structure * [WIP] Version Control * [WIP] Rollback * Update GitSync Structure * WIP GitSync * Copy GitSync from the Develop * Update version control as per feedback * wip: release * release and rollback * GitSync * GitSync * feat: self-hosted and cloud * gitsync backup docs * [WIP] GitSync * GitSync Backup * share app ideation * Share Application * WIP Audit Logs * WIP Okta SAML * wip - okta saml * Okta SAML * Audit Logs * Git Push and Pull * GitSync Backup * Release Management * GitSync Config * gitsync custom branch * Workspace Constants * Workspace Variables * Update License * update: images and css classes * update: images * update: envs * update: images * Img Update till Invite User * update: removed cloud from Dev Life cycle * feat: custom domain * fix: formatting - custom domain * update: workspace doc * metadata img update * Images till Onboard and Offboard * SSO Images * Image Update GitSync * fix: naming * delete sql backup * update: images * Add ToolJet API * Enhance Nav Bar * Update development lifecycle overview * update: images * Nav Bar Update * fix: feedback * Update FAQ dropdown * feedback update * Content Update * fix: images * fix: platform overview image * Update Grammar and Links till Onboard Users * Fix links * Update Self Singup Screenshot * Fix interlinking * Fix GitSync Interlinks * update: interlinking * Delete Old Docs Beta * Delete Old Files from LTS * Replicate Files in LTS * Update Home Page * fix workspace login link * fix links * Deploy ToolJet --------- Co-authored-by: PriteshKiri <pritesh.d.kiri@gmail.com>
4.7 KiB
| id | title |
|---|---|
| multi-environment | Multi-Environment |
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.
Impacted behavior with environment permission
Each environment has a different impact on your application. Please refer the following table for details.
| Action | Development | Staging | Production |
|---|---|---|---|
| Edit versions | ✅ | ❌ | ❌ |
| Rename versions | ✅ | ❌ | ❌ |
| Delete versions | ✅ | ❌ | ❌ |
| Create new versions | ✅ | ❌ | ❌ |
| Promote | ✅ | ✅ | - |
Checkout the Environment-Example guide to learn about multi-environment in ToolJet with a practical example.