Elgato_dark/ToolJet
1
0
Fork 0
mirror of https://github.com/ToolJet/ToolJet synced 2026-04-21 13:37:28 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 5

[docs]: Fix Algolia Broken URLs

Browse source
This commit is contained in:
rudrapratik30 2026-02-18 10:40:00 +05:30
parent 9d5f91f954
commit bfce5c559f
16 changed files with 58 additions and 52 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
docs/static/robots.txt vendored
View file

@ -11,7 +11,7 @@ Disallow: /search
Disallow: /search/
# Allow Algolia crawler
User-agent: Algolia
User-agent: Algoliabot
Allow: /
# Allow AI crawlers

2
docs/versioned_docs/version-3.16.0-LTS/app-builder/building-ui/component-library.md
View file

@ -15,7 +15,7 @@ Components can be added to the canvas by dragging and dropping them onto the can
|:----------|:------------|
| **Buttons** | [Button](/docs/widgets/button/), [Button Group](/docs/widgets/button-group/), [Popover Menu](/docs/widgets/popover-menu/) |
| **Data** | [Table](/docs/widgets/table/), [Chart](/docs/widgets/chart/)|
| **Layouts** | [Form](/docs/widgets/form/), [Modal](/docs/widgets/modal-v2/), [Container](/docs/widgets/container/), [Tabs](/docs/widgets/tabs/), [ListView](/docs/widgets/listview/), [Kanban](/docs/widgets/kanban/), [Calendar](/docs/widgets/calenda/) |
| **Layouts** | [Form](/docs/widgets/form/), [Modal](/docs/widgets/modal-v2/), [Container](/docs/widgets/container/), [Tabs](/docs/widgets/tabs/), [ListView](/docs/widgets/listview/), [Kanban](/docs/widgets/kanban/), [Calendar](/docs/widgets/calendar/) |
| **Text Inputs** | [Text Input](/docs/widgets/text-input/), [Text Area](/docs/widgets/text-area/), [Email Input](/docs/widgets/email-input/), [Password Input](/docs/widgets/password-input/), [Rich Text Editor](/docs/widgets/rich-text-editor/) |
| **Number Inputs** | [Number Input](/docs/widgets/number-input/), [Phone Input](/docs/widgets/phone-input/), [Currency Input](/docs/widgets/currency-input/), [Range Slider](/docs/widgets/range-slider/), [Star Rating](/docs/widgets/star-rating/) |
| **Select Inputs** | [Dropdown](/docs/widgets/dropdown/), [Multi-Select](/docs/widgets/multiselect/), [Toggle Switch](/docs/widgets/toggle-switch-v2/), [Radio Button](/docs/widgets/radio-button-v2/), [Checkbox](/docs/widgets/checkbox/), [Tree Select](/docs/widgets/tree-select/) |

2
docs/versioned_docs/version-3.16.0-LTS/marketplace/plugins/pocketbase.md
View file

@ -21,7 +21,7 @@ ToolJet connects to your PocketBase database, allowing you to directly interact
## Querying PocketBase
- To perform queries on PocketBase in ToolJet, click the **+Add** button in the [query manager](/docs/app-builder/query-panel/#query-manager) located at the bottom panel of the editor.
- To perform queries on PocketBase in ToolJet, click the **+Add** button in the [query manager](/docs/app-builder/connecting-with-data-sources/creating-managing-queries) located at the bottom panel of the editor.
- Select the previously configured PocketBase datasource.
- In the Operation dropdown, select the desired operation type. ToolJet currently [supports](#supported-operations) five query types for PocketBase interactions.
- Enter the collection name and other required parameters for the selected operation and click on **Run** button to run the query.

2
docs/versioned_docs/version-3.16.0-LTS/marketplace/plugins/salesforce.md
View file

@ -29,7 +29,7 @@ Note: After completing the OAuth flow, the query must be triggered again to load
## Querying Salesforce
- To perform queries on Salesforce in ToolJet, click the **+Add** button in the [query manager](/docs/app-builder/query-panel/#query-manager) located at the bottom panel of the editor.
- To perform queries on Salesforce in ToolJet, click the **+Add** button in the [query manager](/docs/app-builder/connecting-with-data-sources/creating-managing-queries) located at the bottom panel of the editor.
- Select the previously configured Salesforce datasource from the **Data Source** dropdown.
- In the Operation dropdown, select the desired operation type. ToolJet supports two operation types for Salesforce interactions:
- **[SOQL Query](#soql-query)** - SOQL (Salesforce Object Query Language) is used to search your organization’s Salesforce data for specific information.

4
docs/versioned_docs/version-3.16.0-LTS/marketplace/plugins/supabase.md
View file

@ -3,8 +3,6 @@ id: marketplace-plugin-supabase
title: Supabase
---
# Supabase
ToolJet connects to your Supabase database, allowing you to directly interact with your Supabase back-end from within your ToolJet application.
:::info
@ -22,7 +20,7 @@ ToolJet connects to your Supabase database, allowing you to directly interact wi
## Querying Supabase
- To perform queries on Supabase in ToolJet, click the **+Add** button in the [query manager](/docs/app-builder/query-panel/#query-manager) located at the bottom panel of the editor.
- To perform queries on Supabase in ToolJet, click the **+Add** button in the [query manager](/docs/app-builder/connecting-with-data-sources/creating-managing-queries) located at the bottom panel of the editor.
- Select the previously configured Supabase datasource.
- In the Operation dropdown, select the desired operation type. ToolJet currently [supports](#supported-operations) five query types for Supabase interactions.
- Enter the table name and other required parameters for the selected operation and click on **Run** button to run the query.

31
docs/versioned_docs/version-3.16.0-LTS/setup/configuration/env-vars.md
View file

@ -56,7 +56,6 @@ Replace `username`, `password`, `hostname`, `port`, and `database_name` with you
- `TOOLJET_DB_BULK_UPLOAD_MAX_ROWS`: Maximum number of rows allowed in bulk upload (default: 5000)
- `TOOLJET_DB_BULK_UPLOAD_MAX_CSV_FILE_SIZE_MB`: Maximum file size of CSV for bulk upload. Default value is 5 MB
#### Why ToolJet Requires Two Databases
ToolJet requires two separate databases for optimal functionality. **TOOLJET_DB** is used to store the platform's internal metadata, including tables created within ToolJet. On the other hand, **PG_DB** acts as the primary database for application data, handling end-user data managed by the apps built on ToolJet.
@ -131,7 +130,7 @@ ToolJet Workflows allows you to design and execute complex, data-centric automat
**External Redis Requirement**: When running separate worker containers or multiple instances, an external stateful Redis instance is **required** for job queue coordination. The built-in Redis only works when the server and worker are in the same container instance (single instance deployment).
:::
For detailed workflow configuration and deployment examples, refer to the [Workflow Migration Guide](./workflow-temporal-to-bullmq-migration).
For detailed workflow configuration and deployment examples, refer to the [Workflow Migration Guide](/docs/setup/workflow-temporal-to-bullmq-migration/).
### Optional Configurations
@ -194,23 +193,25 @@ By default, server accepts maximum JSON size as 50 MB. To increase this limit, u
You can control workflow execution behavior using the following environment variables:
| Variable | Description | Default | Unit |
|-----------|-------------|---------|-------|
| `WORKFLOW_TIMEOUT_SECONDS` | Maximum duration a workflow execution can run before timing out. | 60 | seconds |
| `WORKFLOW_JS_MEMORY_LIMIT` | Maximum memory limit allocated to each `runjs` or `loop` node during execution. | 20 | MB |
| `WORKFLOW_JS_TIMEOUT` | Maximum time allowed for each `runjs` or `loop` node execution. | 100 | milliseconds |
| Variable | Description | Default | Unit |
| -------------------------- | ------------------------------------------------------------------------------- | ------- | ------------ |
| `WORKFLOW_TIMEOUT_SECONDS` | Maximum duration a workflow execution can run before timing out. | 60 | seconds |
| `WORKFLOW_JS_MEMORY_LIMIT` | Maximum memory limit allocated to each `runjs` or `loop` node during execution. | 20 | MB |
| `WORKFLOW_JS_TIMEOUT` | Maximum time allowed for each `runjs` or `loop` node execution. | 100 | milliseconds |
#### Configuring Non Email Identifier for ToolJet OIDC
You can setup OIDC using non email identifier for authenticating users to ToolJet (for example, an employee ID) by setting the following environment variables.
| Variable | Description |
|-----------|-------------|
| `SSO_UNIQUE_ID_FIELD` | Unique identifier field name sent back by the IdP. |
| Variable | Description |
| ------------------------- | ---------------------------------------------------------- |
| `SSO_UNIQUE_ID_FIELD` | Unique identifier field name sent back by the IdP. |
| `SSO_CUSTOM_EMAIL_DOMAIN` | Domain name that will be used to construct dummy email id. |
To learn more, refer to [this section](/docs/user-management/sso/oidc/setup#configuring-tooljet-oidc-with-non-email-identifier).
To learn more, refer to [this section](/docs/user-management/sso/oidc/setup#configuring-tooljet-oidc-with-non-email-identifier).
#### Configure Stronger Password Validation Rules
ToolJet allows you to enforce a stronger password complexity rule. By default, the login password should be atleast 5 characters long and any character can be used. To enforce stronger password validation, use the following environment variable:
- `ENABLE_PASSWORD_COMPLEXITY_RULES = true`
@ -218,15 +219,16 @@ ToolJet allows you to enforce a stronger password complexity rule. By default, t
When **false**, passwords will follow the default validations. When **true**, passwords must meet all the following rules:
| Rule | Requirement |
|-----------|-------------|
| Password length | 12-24 characters |
| Password length | 12-24 characters |
| Uppercase letters | A-Z |
| Lowercase letters | a-z |
| Numbers | 0-9 |
| Special characters | ! @ # $ % ^ & * ( ) _ + - = \{ \} [ ] : ; ” ' , . ? / \ \| |
| Special characters | ! @ # $ % ^ & \* ( ) \_ + - = \{ \} [ ] : ; ” ' , . ? / \ \| |
:::info
These validations apply to both the instance and workspace levels.
:::
### Third-Party Integrations
#### Slack
@ -374,8 +376,7 @@ Only enable `OTEL_INCLUDE_QUERY_TEXT=true` for debugging. This creates high card
For comprehensive setup instructions, metrics details, and Grafana dashboard integration, see the [OpenTelemetry Observability](/docs/tj-setup/observability/observability-otel) documentation.
<br/>
---
## <br/>
## Need Help?

49
docs/versioned_docs/version-3.16.0-LTS/setup/docker.md
View file

@ -8,7 +8,6 @@ sidebar_label: Docker
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
Follow the steps below to deploy ToolJet on a server using Docker Compose. ToolJet requires a PostgreSQL database to store applications definitions, (encrypted) credentials for datasources and user authentication data.
::::info
@ -43,11 +42,13 @@ There are two options to deploy ToolJet using Docker Compose:
2. **With external PostgreSQL database**. This setup is recommended if you want to use a managed PostgreSQL service such as AWS RDS or Google Cloud SQL.
Confused about which setup to select? Feel free to ask the community via [Slack](https://join.slack.com/t/tooljet/shared_invite/zt-2rk4w42t0-ZV_KJcWU9VL1BBEjnSHLCA).
<!--
<!--
<Tabs>
<TabItem value="with-in-built-postgres" label="With in-built PostgreSQL" default> -->
#### 1. Download our production docker-compose file into the server.
<Tabs>
<TabItem value="with-in-built-postgres" label="With in-built PostgreSQL" default>
@ -62,10 +63,11 @@ Confused about which setup to select? Feel free to ask the community via [Slack]
curl -LO https://tooljet-deployments.s3.us-west-1.amazonaws.com/docker/docker-compose.yaml
```
</TabItem>
</Tabs>
#### 2. Create `.env` file in the current directory (where the docker-compose.yaml file is downloaded as in step 1):
<Tabs>
<TabItem value="with-in-built-postgres" label="With in-built PostgreSQL" default>
@ -87,6 +89,7 @@ Confused about which setup to select? Feel free to ask the community via [Slack]
mv .env.external.example .env && ./external.sh
```
</TabItem>
</Tabs>
#### 3. To start the docker container, use the following command:
@ -127,6 +130,7 @@ If you've set a custom domain for `TOOLJET_HOST`, add a `A record` entry in your
iv. Setup docker to run without root privileges by following the instructions written here https://docs.docker.com/engine/install/linux-postinstall/
:::
</TabItem>
</Tabs>
Also, for setting up additional environment variables in the .env file, please check our documentation on [environment variable](/docs/setup/env-vars)
@ -136,21 +140,21 @@ Also, for setting up additional environment variables in the .env file, please c
The below bash script will help with taking back-up and as well as restoring:
1. Download the script:
```bash
curl -LO https://tooljet-deployments.s3.us-west-1.amazonaws.com/docker/backup-restore.sh && chmod +x backup-restore.sh
```
```bash
curl -LO https://tooljet-deployments.s3.us-west-1.amazonaws.com/docker/backup-restore.sh && chmod +x backup-restore.sh
```
2. Run the script with the following command:
```bash
./backup-restore.sh
```
<img className="screenshot-full img-full" src="/img/setup/docker/backup-and-restore.gif" alt="Docker - Backup and Restore" />
```bash
./backup-restore.sh
```
<img className="screenshot-full img-full" src="/img/setup/docker/backup-and-restore.gif" alt="Docker - Backup and Restore" />
## Workflows
ToolJet Workflows allows users to design and execute complex, data-centric automations using a visual, node-based interface. This feature enhances ToolJet's functionality beyond building secure internal tools, enabling developers to automate complex business processes.
:::info
For users migrating from Temporal-based workflows, please refer to the [Workflow Migration Guide](./workflow-temporal-to-bullmq-migration).
For users migrating from Temporal-based workflows, please refer to the [Workflow Migration Guide](/docs/setup/workflow-temporal-to-bullmq-migration/).
:::
### Enabling Workflow Scheduling
@ -290,36 +294,39 @@ Users on versions earlier than **v2.23.0-ee2.10.2** must first upgrade to this v
After completing the PostgreSQL backup, follow the steps below to upgrade to the latest LTS version:
1. **Stop the Running Containers**
Run the following command on your server (in the directory where your *docker-compose.yml* file is located):
Run the following command on your server (in the directory where your _docker-compose.yml_ file is located):
```bash
docker compose down
```
This will stop the running containers while preserving your volumes and data.
2. **Get the Latest LTS Tag from Docker Hub**
You can visit the official [ToolJet Docker Hub](https://hub.docker.com/r/tooljet/tooljet/tags) page to get the latest image tag.
3. **Update the *docker-compose.yml* File**
Open your *docker-compose.yml* file and update the *image* field under the *tooljet* service:
3. **Update the _docker-compose.yml_ File**
Open your _docker-compose.yml_ file and update the _image_ field under the _tooljet_ service:
```yaml
services:
tooljet:
image: tooljet/tooljet:v3.x.x-lts # Replace with the latest LTS tag
services:
tooljet:
image: tooljet/tooljet:v3.x.x-lts # Replace with the latest LTS tag
```
:::note
Replace v3.x.x-lts with the exact LTS version tag copied from Docker Hub.
:::
4. **Start ToolJet with the New Version**
After updating the image tag in your *docker-compose.yml* file, run the following command on your server (in the same directory):
After updating the image tag in your _docker-compose.yml_ file, run the following command on your server (in the same directory):
```bash
docker compose up -d
```
Docker will pull the new image and recreate the containers using the updated version.
<br/>
---
## <br/>
## Need Help?

2
docs/versioned_docs/version-3.16.0-LTS/setup/kubernetes/kubernetes-aks.md
View file

@ -107,7 +107,7 @@ You will be able to access your ToolJet installation once the pods and services
ToolJet Workflows allows users to design and execute complex, data-centric automations using a visual, node-based interface. This feature enhances ToolJet's functionality beyond building secure internal tools, enabling developers to automate complex business processes.
:::info
For users migrating from Temporal-based workflows, please refer to the [Workflow Migration Guide](./workflow-temporal-to-bullmq-migration).
For users migrating from Temporal-based workflows, please refer to the [Workflow Migration Guide](/docs/setup/workflow-temporal-to-bullmq-migration/).
:::
### Enabling Workflow Scheduling

2
docs/versioned_docs/version-3.16.0-LTS/setup/kubernetes/kubernetes-eks.md
View file

@ -151,7 +151,7 @@ To use ToolJet AI features in your deployment, make sure to whitelist `https://a
ToolJet Workflows allows users to design and execute complex, data-centric automations using a visual, node-based interface. This feature enhances ToolJet's functionality beyond building secure internal tools, enabling developers to automate complex business processes.
:::info
For users migrating from Temporal-based workflows, please refer to the [Workflow Migration Guide](./workflow-temporal-to-bullmq-migration).
For users migrating from Temporal-based workflows, please refer to the [Workflow Migration Guide](/docs/setup/workflow-temporal-to-bullmq-migration/).
:::
### Enabling Workflow Scheduling

2
docs/versioned_docs/version-3.16.0-LTS/setup/kubernetes/kubernetes-gke.md
View file

@ -132,7 +132,7 @@ You will be able to access your ToolJet installation once the pods, service and
ToolJet Workflows allows users to design and execute complex, data-centric automations using a visual, node-based interface. This feature enhances ToolJet's functionality beyond building secure internal tools, enabling developers to automate complex business processes.
:::info
For users migrating from Temporal-based workflows, please refer to the [Workflow Migration Guide](./workflow-temporal-to-bullmq-migration).
For users migrating from Temporal-based workflows, please refer to the [Workflow Migration Guide](/docs/setup/workflow-temporal-to-bullmq-migration/).
:::
### Enabling Workflow Scheduling

2
docs/versioned_docs/version-3.16.0-LTS/setup/kubernetes/kubernetes.md
View file

@ -116,7 +116,7 @@ Follow the steps below to deploy ToolJet on a Kubernetes cluster.
ToolJet Workflows allows users to design and execute complex, data-centric automations using a visual, node-based interface. This feature enhances ToolJet's functionality beyond building secure internal tools, enabling developers to automate complex business processes.
:::info
For users migrating from Temporal-based workflows, please refer to the [Workflow Migration Guide](./workflow-temporal-to-bullmq-migration).
For users migrating from Temporal-based workflows, please refer to the [Workflow Migration Guide](/docs/setup/workflow-temporal-to-bullmq-migration/).
:::
### Enabling Workflow Scheduling

2
docs/versioned_docs/version-3.16.0-LTS/setup/kubernetes/openshift.md
View file

@ -125,7 +125,7 @@ If there are self signed HTTPS endpoints that Tooljet needs to connect to, pleas
ToolJet Workflows allows users to design and execute complex, data-centric automations using a visual, node-based interface. This feature enhances ToolJet's functionality beyond building secure internal tools, enabling developers to automate complex business processes.
:::info
For users migrating from Temporal-based workflows, please refer to the [Workflow Migration Guide](./workflow-temporal-to-bullmq-migration).
For users migrating from Temporal-based workflows, please refer to the [Workflow Migration Guide](/docs/setup/workflow-temporal-to-bullmq-migration/).
:::
### Enabling Workflow Scheduling

2
docs/versioned_docs/version-3.16.0-LTS/setup/managed-cloud/aws/ami.md
View file

@ -150,7 +150,7 @@ Follow the steps below to manually deploy ToolJet on AWS AMI instances.
ToolJet Workflows allows users to design and execute complex, data-centric automations using a visual, node-based interface. This feature enhances ToolJet's functionality beyond building secure internal tools, enabling developers to automate complex business processes.
:::info
For users migrating from Temporal-based workflows, please refer to the [Workflow Migration Guide](./workflow-temporal-to-bullmq-migration).
For users migrating from Temporal-based workflows, please refer to the [Workflow Migration Guide](/docs/setup/workflow-temporal-to-bullmq-migration/).
:::
### Enabling Workflow Scheduling

2
docs/versioned_docs/version-3.16.0-LTS/setup/managed-cloud/aws/ecs.md
View file

@ -198,7 +198,7 @@ ToolJet Database is a built-in feature that allows you to build apps faster and
ToolJet Workflows allows users to design and execute complex, data-centric automations using a visual, node-based interface. This feature enhances ToolJet's functionality beyond building secure internal tools, enabling developers to automate complex business processes.
:::info
For users migrating from Temporal-based workflows, please refer to the [Workflow Migration Guide](./workflow-temporal-to-bullmq-migration).
For users migrating from Temporal-based workflows, please refer to the [Workflow Migration Guide](/docs/setup/workflow-temporal-to-bullmq-migration/).
:::
### Enabling Workflow Scheduling

2
docs/versioned_docs/version-3.16.0-LTS/setup/managed-cloud/azure-container.md
View file

@ -126,7 +126,7 @@ Use the ToolJet-hosted database to build apps faster, and manage your data with
ToolJet Workflows allows users to design and execute complex, data-centric automations using a visual, node-based interface. This feature enhances ToolJet's functionality beyond building secure internal tools, enabling developers to automate complex business processes.
:::info
For users migrating from Temporal-based workflows, please refer to the [Workflow Migration Guide](./workflow-temporal-to-bullmq-migration).
For users migrating from Temporal-based workflows, please refer to the [Workflow Migration Guide](/docs/setup/workflow-temporal-to-bullmq-migration/).
:::
### Enabling Workflow Scheduling

2
docs/versioned_docs/version-3.16.0-LTS/setup/managed-cloud/google-cloud-run.md
View file

@ -128,7 +128,7 @@ ToolJet Database is a built-in feature that allows you to build apps faster and
ToolJet Workflows allows users to design and execute complex, data-centric automations using a visual, node-based interface. This feature enhances ToolJet's functionality beyond building secure internal tools, enabling developers to automate complex business processes.
:::info
For users migrating from Temporal-based workflows, please refer to the [Workflow Migration Guide](./workflow-temporal-to-bullmq-migration).
For users migrating from Temporal-based workflows, please refer to the [Workflow Migration Guide](/docs/setup/workflow-temporal-to-bullmq-migration/).
:::
### Enabling Workflow Scheduling