mirror of
https://github.com/ToolJet/ToolJet
synced 2026-05-05 22:38:48 +00:00
Merge branch 'release/v1.12.1'
This commit is contained in:
Akshay Sasidharan
commit
3ffa765ae3
124 changed files with 813 additions and 223 deletions
2
.version
2
.version
|
|
@ -1 +1 @@
|
|||
1.12.0
|
||||
1.12.1
|
||||
|
|
|
|||
|
|
@ -1,3 +1,7 @@
|
|||
---
|
||||
id: audit_logs
|
||||
title: Audit logs
|
||||
---
|
||||
# Audit logs
|
||||
|
||||
The audit log is the report of all the activities done in your ToolJet account. It will capture and display events automatically by recording who performed an activity, what when, and where the activity was performed, along with other information such as IP address.
|
||||
|
|
|
|||
|
|
@ -1,5 +1,6 @@
|
|||
---
|
||||
sidebar_label: Generate file
|
||||
id: generate-file
|
||||
title: Generate file
|
||||
---
|
||||
|
||||
# Generate file
|
||||
|
|
|
|||
|
|
@ -1,5 +1,6 @@
|
|||
---
|
||||
sidebar_label: Set localStorage
|
||||
id: set-localstorage
|
||||
title: Set localStorage
|
||||
---
|
||||
|
||||
# Set localStorage
|
||||
|
|
|
|||
|
|
@ -1,10 +1,10 @@
|
|||
---
|
||||
sidebar_position: 3
|
||||
sidebar_label: Code of Conduct
|
||||
id: code-of-conduct
|
||||
title: Contributor Code of Conduct
|
||||
---
|
||||
|
||||
# Contributor Covenant Code of Conduct
|
||||
 
|
||||
|
||||
## Our Pledge
|
||||
|
||||
In the interest of fostering an open and welcoming environment, we as
|
||||
|
|
|
|||
|
|
@ -1,5 +1,6 @@
|
|||
---
|
||||
sidebar_position: 1
|
||||
id: docker
|
||||
title: Docker
|
||||
---
|
||||
|
||||
# Docker
|
||||
|
|
|
|||
|
|
@ -1,5 +1,6 @@
|
|||
---
|
||||
sidebar_position: 1
|
||||
id: macos
|
||||
title: Mac OS
|
||||
---
|
||||
|
||||
# Mac OS
|
||||
|
|
@ -1,5 +1,6 @@
|
|||
---
|
||||
sidebar_position: 1
|
||||
id: ubuntu
|
||||
title: Ubuntu
|
||||
---
|
||||
|
||||
# Ubuntu
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
sidebar_position: 4
|
||||
sidebar_label: Slack Code of Conduct
|
||||
id: slackcoc
|
||||
title: Slack Code of Conduct
|
||||
---
|
||||
|
||||
# Slack Code of Conduct
|
||||
|
|
|
|||
|
|
@ -1,5 +1,6 @@
|
|||
---
|
||||
sidebar_position: 1
|
||||
id: creating-widget
|
||||
title: Creating Widgets
|
||||
---
|
||||
|
||||
# Creating Widgets
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
sidebar_position: 2
|
||||
sidebar_label: Creating a plugin
|
||||
id: creating-a-plugin
|
||||
title: Creating Plugins
|
||||
---
|
||||
|
||||
# Creating plugins for ToolJet
|
||||
|
|
|
|||
|
|
@ -1,5 +1,6 @@
|
|||
---
|
||||
sidebar_position: 1
|
||||
id: airtable
|
||||
title: Airtable
|
||||
---
|
||||
|
||||
# Airtable
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
sidebar_position: 2
|
||||
sidebar_label: Appwrite
|
||||
id: appwrite
|
||||
title: Appwrite Database
|
||||
---
|
||||
|
||||
# Appwrite Database
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
sidebar_position: 3
|
||||
sidebar_label: Baserow
|
||||
id: baserow
|
||||
title: Baserow
|
||||
---
|
||||
|
||||
# Baserow
|
||||
|
|
|
|||
|
|
@ -1,5 +1,6 @@
|
|||
---
|
||||
sidebar_position: 3
|
||||
id: bigquery
|
||||
title: BigQuery
|
||||
---
|
||||
|
||||
# BigQuery
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
sidebar_position: 4.1
|
||||
sidebar_label: CouchDB
|
||||
id: couchdb
|
||||
title: CouchDB
|
||||
---
|
||||
|
||||
# CouchDB
|
||||
|
|
|
|||
|
|
@ -1,5 +1,6 @@
|
|||
---
|
||||
sidebar_position: 5
|
||||
id: custom-js
|
||||
title: Custom JavaScript
|
||||
---
|
||||
|
||||
# Custom JavaScript
|
||||
|
|
|
|||
|
|
@ -1,5 +1,6 @@
|
|||
---
|
||||
sidebar_position: 6
|
||||
id: dynamodb
|
||||
title: DynamoDB
|
||||
---
|
||||
|
||||
# DynamoDB
|
||||
|
|
|
|||
|
|
@ -1,5 +1,6 @@
|
|||
---
|
||||
sidebar_position: 7
|
||||
id: elasticsearch
|
||||
title: Elasticsearch
|
||||
---
|
||||
|
||||
# Elasticsearch
|
||||
|
|
|
|||
|
|
@ -1,5 +1,6 @@
|
|||
---
|
||||
sidebar_position: 4
|
||||
id: firestore
|
||||
title: Cloud Firestore
|
||||
---
|
||||
|
||||
# Cloud Firestore
|
||||
|
|
|
|||
|
|
@ -1,5 +1,6 @@
|
|||
---
|
||||
sidebar_position: 8
|
||||
id: gcs
|
||||
title: Google Cloud Storage
|
||||
---
|
||||
|
||||
# Google Cloud Storage
|
||||
|
|
|
|||
|
|
@ -1,5 +1,6 @@
|
|||
---
|
||||
sidebar_position: 9
|
||||
id: google.sheets
|
||||
title: Google Sheets
|
||||
---
|
||||
|
||||
# Google Sheets
|
||||
|
|
|
|||
|
|
@ -1,5 +1,6 @@
|
|||
---
|
||||
sidebar_position: 10
|
||||
id: graphql
|
||||
title: GraphQL
|
||||
---
|
||||
|
||||
# GraphQL
|
||||
|
|
|
|||
|
|
@ -1,5 +1,6 @@
|
|||
---
|
||||
sidebar_position: 10.1
|
||||
id: influxdb
|
||||
title: InfluxDB
|
||||
---
|
||||
|
||||
# InfluxDB
|
||||
|
|
|
|||
|
|
@ -1,5 +1,6 @@
|
|||
---
|
||||
sidebar_position: 11
|
||||
id: mailgun
|
||||
title: Mailgun
|
||||
---
|
||||
|
||||
# Mailgun
|
||||
|
|
|
|||
|
|
@ -1,5 +1,6 @@
|
|||
---
|
||||
sidebar_position: 12
|
||||
id: minio
|
||||
title: MinIO
|
||||
---
|
||||
|
||||
# MinIO
|
||||
|
|
|
|||
|
|
@ -1,5 +1,6 @@
|
|||
---
|
||||
sidebar_position: 13
|
||||
id: mongodb
|
||||
title: MongoDB
|
||||
---
|
||||
|
||||
# MongoDB
|
||||
|
|
|
|||
|
|
@ -1,5 +1,6 @@
|
|||
---
|
||||
sidebar_position: 14
|
||||
id: mssql
|
||||
title: MS SQL Server / Azure SQL databases
|
||||
---
|
||||
|
||||
# MS SQL Server / Azure SQL databases
|
||||
|
|
|
|||
|
|
@ -1,5 +1,6 @@
|
|||
---
|
||||
sidebar_position: 15
|
||||
id: mysql
|
||||
title: MySQL
|
||||
---
|
||||
|
||||
# MySQL
|
||||
|
|
|
|||
|
|
@ -1,5 +1,6 @@
|
|||
---
|
||||
sidebar_position: 16
|
||||
id: n8n
|
||||
title: n8n
|
||||
---
|
||||
|
||||
# n8n
|
||||
|
|
|
|||
|
|
@ -1,126 +1,249 @@
|
|||
# notion
|
||||
---
|
||||
id: notion
|
||||
title: Notion
|
||||
---
|
||||
# Notion
|
||||
|
||||
ToolJet can connect to a Notion workspace to do operations on notion pages, databases and blocks.
|
||||
## Connection
|
||||
We can easily integrate notion with tooljet using just an API token. Read [Create internal integration with notion API](https://www.notion.so/help/create-integrations-with-the-notion-api)
|
||||
|
||||
For integrating Notion with ToolJet we will need the API token. The API token can be generated from your Notion workspace settings. Read the official Notion docs for [Creating an internal integration with notion API](https://www.notion.so/help/create-integrations-with-the-notion-api).
|
||||
|
||||
<div style={{textAlign: 'center'}}>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
## Querying Notion
|
||||
|
||||
Notion API provides api support for database, page, block, user
|
||||
Notion API provides support for:
|
||||
- **[Database](#database)**
|
||||
- **[Page](#page)**
|
||||
- **[Block](#blocks)**
|
||||
- **[User](#user)**
|
||||
|
||||
<div style={{textAlign: 'center'}}>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
:::tip
|
||||
|
||||
Before querying Notion, you must share the database with your integration. Click the share button in your database view, find your integration name select it.
|
||||
|
||||
<div style={{textAlign: 'center'}}>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
:::
|
||||
|
||||
### Database
|
||||
|
||||
- Retrieve a database
|
||||
On database resource you can perform the following operations:
|
||||
- **[Retrieve a database](#1-retrieve-a-database)**
|
||||
- **[Query a database](#2-query-a-database)**
|
||||
- **[Create a database](#3-create-a-database)**
|
||||
- **[Update a database](#4-update-a-database)**
|
||||
|
||||
#### **Properties**
|
||||
<div style={{textAlign: 'center'}}>
|
||||
|
||||
- Database ID
|
||||
|
||||
|
||||
- Query a database
|
||||
</div>
|
||||
|
||||
#### **Properties**
|
||||
#### 1. Retrieve a database
|
||||
|
||||
- Database ID
|
||||
- Filter : This must be an object of filters
|
||||
- Children : Array of sort objects
|
||||
- Limit : limit for pagination
|
||||
- Start Cursor : Next object id to continue pagination
|
||||
This operations retreives a Database object using the ID specified.
|
||||
|
||||
- Create a database
|
||||
#### **Properties**
|
||||
- Database ID
|
||||
- Title : Title should be an array of rich_text properties
|
||||
- Properties : Properties defines the columns in a database
|
||||
- Icon type : Currently notion api accepts two icon options, emoji, external URL
|
||||
- Icon value: Value of selected icon type
|
||||
- Icon type : Currently notion api accepts only external URL
|
||||
- Cover value: Value of selected cover type
|
||||
##### Required parameters:
|
||||
|
||||
- Update a database
|
||||
#### **Properties**
|
||||
- Database ID
|
||||
- Title
|
||||
- Properties
|
||||
- Icon type
|
||||
- Icon value
|
||||
- Icon type
|
||||
- Cover value
|
||||
- **Database ID**: You'll find the Database ID in the url. Suppose this is the example url: `https://www.notion.so/workspace/XXX?v=YYY&p=ZZZ` then `XXX` is the database ID, `YYY` is the view ID and `ZZZ` is the page ID.
|
||||
|
||||
<div style={{textAlign: 'center'}}>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
#### 2. Query a database
|
||||
|
||||
This operation gets a list of **Pages** contained in the database, filtered and ordered according to the filter conditions and sort criteria provided in the query.
|
||||
##### Required parameters:
|
||||
|
||||
- **Database ID** : You'll find the Database ID in the url. Suppose this is the example url: `https://www.notion.so/workspace/XXX?v=YYY&p=ZZZ` then `XXX` is the database ID, `YYY` is the view ID and `ZZZ` is the page ID.
|
||||
|
||||
##### Optional parameters:
|
||||
|
||||
- **Filter** : This must be an object of filters
|
||||
- **Sort** : Array of sort objects
|
||||
- **Limit** : limit for pagination
|
||||
- **Start Cursor** : Next object id to continue pagination
|
||||
|
||||
#### 3. Create a database
|
||||
|
||||
This opertion creates a database as a subpage in the specified parent page, with the specified properties.
|
||||
|
||||
##### Required parameters:
|
||||
|
||||
- **Database ID** : You'll find the Database ID in the url. Suppose this is the example url: `https://www.notion.so/workspace/XXX?v=YYY&p=ZZZ` then `XXX` is the database ID, `YYY` is the view ID and `ZZZ` is the page ID.
|
||||
- **Page ID** : Page ID of the parent
|
||||
- **Properties** : Properties defines the columns in a database
|
||||
|
||||
##### Optional parameters:
|
||||
|
||||
- **Title** : Title should be an array of rich_text properties
|
||||
- **Icon type** : Currently notion api accepts two icon options, emoji, external URL
|
||||
- **Icon value** : Value of selected icon type
|
||||
- **Icon type** : Currently notion api accepts only external URL
|
||||
- **Cover value** : Value of selected cover type
|
||||
|
||||
#### 4. Update a database
|
||||
|
||||
This operation updates an existing database as specified by the parameters.
|
||||
|
||||
##### Required parameters:
|
||||
- **Database ID**
|
||||
|
||||
##### Optional parameters:
|
||||
|
||||
- **Title** : Title should be an array of rich_text properties
|
||||
- **Properties** : Properties defines the columns in a database
|
||||
- **Icon type** : Currently notion api accepts two icon options, emoji, external URL
|
||||
- **Icon value** : Value of selected icon type
|
||||
- **Icon type** : Currently notion api accepts only external URL
|
||||
- **Cover value** : Value of selected cover type
|
||||
|
||||
### Page
|
||||
|
||||
- Retrieve a page
|
||||
#### **Properties**
|
||||
- Page ID
|
||||
On page resource you can perform the following operations:
|
||||
- **[Retrieve a page](#1-retrieve-a-page)**
|
||||
- **[Create a page](#2-create-a-page)**
|
||||
- **[Update a page](#3-update-a-page)**
|
||||
- **[Retrieve a page property](#4-retrieve-a-page-property-item)**
|
||||
- **[Archive a page](#5-archive-delete-a-page)**
|
||||
|
||||
- Retrieve a page property item
|
||||
#### **Properties**
|
||||
- Page ID
|
||||
- Property ID
|
||||
- Limit
|
||||
- Start cursor
|
||||
<div style={{textAlign: 'center'}}>
|
||||
|
||||
- Update a page
|
||||
#### **Properties**
|
||||
- Page ID
|
||||
- Parent type: A database parent or page parent
|
||||
- Properties : Property values of this page
|
||||
- Children : Page content for the new page as an array of block objects
|
||||
- Icon type : Currently notion api accepts two icon options, emoji, external URL
|
||||
- Icon value: Value of selected icon type
|
||||
- Icon type : Currently notion api accepts only external URL
|
||||
- Cover value: Value of selected cover type
|
||||
|
||||
|
||||
- Create a page
|
||||
#### **Properties**
|
||||
- Page ID
|
||||
- Properties : Property values of this page
|
||||
- Icon type : Currently notion api accepts two icon options, emoji, external URL
|
||||
- Icon value: Value of selected icon type
|
||||
- Icon type : Currently notion api accepts only external URL
|
||||
- Cover value: Value of selected cover type
|
||||
</div>
|
||||
|
||||
- Archive (delete) a page
|
||||
#### **Properties**
|
||||
- Page ID
|
||||
- Archive: Dropdown for archive and un archive the page
|
||||
#### 1. Retrieve a page
|
||||
This operation retrieves a **Page** object using the ID specified.
|
||||
##### Required parameters:
|
||||
- **Page ID**
|
||||
|
||||
#### 2. Create a page
|
||||
This operation creates a new page in the specified database or as a child of an existing page. If the parent is a database, the property values of the new page in the properties parameter must conform to the parent database's property schema. If the parent is a page, the only valid property is title.
|
||||
##### Parameters:
|
||||
- **Page ID**
|
||||
- **Properties** : Property values of this page
|
||||
- **Icon type** : Currently notion api accepts two icon options, emoji, external URL
|
||||
- **Icon value**: Value of selected icon type
|
||||
- **Icon type** : Currently notion api accepts only external URL
|
||||
- **Cover value** : Value of selected cover type
|
||||
|
||||
#### 3. Update a page
|
||||
This operation updates page property values for the specified page. Properties that are not set via the properties parameter will remain unchanged.
|
||||
##### Parameters:
|
||||
- **Page ID**
|
||||
- **Parent type**: A database parent or page parent
|
||||
- **Properties** : Property values of this page
|
||||
- **Children** : Page content for the new page as an array of block objects
|
||||
- **Icon type** : Currently notion api accepts two icon options, emoji, external URL
|
||||
- **Icon value**: Value of selected icon type
|
||||
- **Icon type** : Currently notion api accepts only external URL
|
||||
- **Cover value** : Value of selected cover type
|
||||
|
||||
#### 4. Retrieve a page property item
|
||||
This operation retrieves a property_item object for a given page ID and property ID. Depending on the property type, the object returned will either be a value or a paginated list of property item values. See Property item objects for specifics.
|
||||
##### Parameters:
|
||||
- **Page ID**
|
||||
- **Property ID**
|
||||
- **Limit**
|
||||
- **Start cursor**
|
||||
|
||||
#### 5. Archive (delete) a page
|
||||
##### Required parameters:
|
||||
- **Page ID**
|
||||
- **Archive**: Dropdown for archive and un archive the page
|
||||
|
||||
|
||||
### Blocks
|
||||
The following operations can be performed on the block resource:
|
||||
- **[Retrieve a block](#1-retrieve-a-block)**
|
||||
- **[Append block children](#2-append-new-block-children)**
|
||||
- **[Retrieve block children](#3-retrieve-block-children)**
|
||||
- **[Update a block](#4-update-a-block)**
|
||||
- **[Delete a block](#5-delete-a-block)**
|
||||
|
||||
- Retrieve a block
|
||||
#### **Properties**
|
||||
- Block ID
|
||||
<div style={{textAlign: 'center'}}>
|
||||
|
||||
- Retrieve block children
|
||||
#### **Properties**
|
||||
- Block ID
|
||||
- Limit
|
||||
- Start cursor
|
||||
|
||||
|
||||
- Update a block
|
||||
#### **Properties**
|
||||
- Block ID
|
||||
- Properties: The block object type value with the properties to be updated
|
||||
- Archive
|
||||
</div>
|
||||
|
||||
- Append new block children
|
||||
#### **Properties**
|
||||
- Block ID
|
||||
- Children: Array of block objects
|
||||
:::info
|
||||
To get the id for blocks, simply click on the menu icon for the block and click "Copy link". Afterwards, paste the link in the browser and it should look like this: `https://www.notion.so/Creating-Page-Sample-ee18b8779ae54f358b09221d6665ee15#7fcb3940a1264aadb2ad4ee9ffe11b0e` the string after **#** is the block id i.e. `7fcb3940a1264aadb2ad4ee9ffe11b0e`.
|
||||
:::
|
||||
|
||||
- Delete a block
|
||||
#### **Properties**
|
||||
- Block ID
|
||||
#### 1. Retrieve a block
|
||||
This operation retrieves a **Block** object using the ID specified.
|
||||
|
||||
##### Required parameters:
|
||||
- **Block ID**
|
||||
|
||||
#### 2. Append new block children
|
||||
This operation creates and appends new children blocks to the parent block_id specified.
|
||||
|
||||
##### Required parameters:
|
||||
- **Block ID**
|
||||
- **Children**: Array of block objects
|
||||
|
||||
#### 3. Retrieve block children
|
||||
This operation retrieves a paginated array of child block objects contained in the block using the ID specified.
|
||||
|
||||
##### Required parameters:
|
||||
- **Block ID**
|
||||
- **Limit**
|
||||
- **Start cursor**
|
||||
|
||||
#### 4. Update a block
|
||||
This operation updates the content for the specified block_id based on the block type.
|
||||
|
||||
##### Required parameters:
|
||||
- **Block ID**
|
||||
- **Properties**: The block object type value with the properties to be updated
|
||||
- **Archive**
|
||||
|
||||
#### 5. Delete a block
|
||||
##### Required parameters:
|
||||
- **Block ID**
|
||||
|
||||
### User
|
||||
The following operations can be performed on the user notion resource:
|
||||
|
||||
- Retrieve a user from current workspace
|
||||
#### **Properties**
|
||||
- User ID
|
||||
|
||||
- Retrieve list of users of a workspace
|
||||
#### **Properties**
|
||||
- Limit
|
||||
- Start cursor
|
||||
#### 1. Retrieve a user from current workspace
|
||||
This operation retrieves a User using the ID specified.
|
||||
|
||||
<div style={{textAlign: 'center'}}>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
##### Required parameters:
|
||||
- **User ID**
|
||||
|
||||
#### 2. Retrieve list of users of a workspace
|
||||
|
||||
This operation returns a paginated list of Users for the workspace.
|
||||
|
||||
##### Required parameters:
|
||||
- **Limit**
|
||||
- **Start cursor**
|
||||
|
||||
[Read more about notion API](https://developers.notion.com/reference/intro)
|
||||
|
|
|
|||
|
|
@ -1,5 +1,9 @@
|
|||
---
|
||||
id: openapi
|
||||
title: OpenAPI
|
||||
---
|
||||
|
||||
# openapi
|
||||
# OpenAPI
|
||||
|
||||
ToolJet has a data source for generating REST API operations from OpenAPI Specs.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,6 @@
|
|||
---
|
||||
sidebar_position: 16.1
|
||||
id: oracledb
|
||||
title: Oracle DB
|
||||
---
|
||||
|
||||
# Oracle DB
|
||||
|
|
|
|||
|
|
@ -1,5 +1,6 @@
|
|||
---
|
||||
sidebar_position: 17
|
||||
id: postgresql
|
||||
title: PostgreSQL
|
||||
---
|
||||
|
||||
# PostgreSQL
|
||||
|
|
|
|||
|
|
@ -1,5 +1,6 @@
|
|||
---
|
||||
sidebar_position: 18
|
||||
id: redis
|
||||
title: Redis
|
||||
---
|
||||
|
||||
# Redis
|
||||
|
|
|
|||
|
|
@ -1,5 +1,6 @@
|
|||
---
|
||||
sidebar_position: 19
|
||||
id: restapi
|
||||
title: REST API
|
||||
---
|
||||
|
||||
# REST API
|
||||
|
|
|
|||
|
|
@ -1,5 +1,6 @@
|
|||
---
|
||||
sidebar_position: 26
|
||||
id: rethinkdb
|
||||
title: Rethinkdb
|
||||
---
|
||||
# Rethinkdb
|
||||
|
||||
|
|
|
|||
|
|
@ -1,5 +1,6 @@
|
|||
---
|
||||
sidebar_position: 1.1
|
||||
id: s3
|
||||
title: Amazon S3
|
||||
---
|
||||
|
||||
# Amazon S3
|
||||
|
|
|
|||
|
|
@ -1,5 +1,6 @@
|
|||
---
|
||||
sidebar_position: 21
|
||||
id: sendgrid
|
||||
title: SendGrid
|
||||
---
|
||||
|
||||
# SendGrid
|
||||
|
|
|
|||
|
|
@ -1,8 +1,8 @@
|
|||
---
|
||||
sidebar_position: 22
|
||||
id: smtp
|
||||
title: SMTP
|
||||
---
|
||||
|
||||
|
||||
# SMTP
|
||||
|
||||
SMTP plugin can connect ToolJet applications to **SMTP servers** for sending emails.
|
||||
|
|
|
|||
|
|
@ -1,5 +1,6 @@
|
|||
---
|
||||
sidebar_position: 23
|
||||
id: snowflake
|
||||
title: Snowflake
|
||||
---
|
||||
|
||||
# Snowflake
|
||||
|
|
|
|||
|
|
@ -1,5 +1,6 @@
|
|||
---
|
||||
sidebar_position: 24
|
||||
id: typesense
|
||||
title: TypeSense
|
||||
---
|
||||
|
||||
# TypeSense
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
sidebar_position: 2
|
||||
sidebar_label: REST API authentication using OAuth 2.0
|
||||
id: oauth2-authorization
|
||||
title: REST API authentication using OAuth 2.0
|
||||
---
|
||||
|
||||
# REST API authentication using OAuth 2.0
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
sidebar_position: 3
|
||||
sidebar_label: Upload files using GCS
|
||||
id: upload-files-gcs
|
||||
title: Upload files using GCS
|
||||
---
|
||||
|
||||
# Upload files using GCS
|
||||
|
|
|
|||
|
|
@ -1,5 +1,8 @@
|
|||
---
|
||||
sidebar_position: 1
|
||||
id: introduction
|
||||
title: Introduction
|
||||
description: ToolJet is an **open-source low-code framework** to build and deploy custom internal tools. ToolJet can connect to your data sources such as databases ( PostgreSQL, MongoDB, MySQL, Elasticsearch, Firestore, DynamoDB, Redis and more ), API endpoints ( ToolJet supports OAuth2 authorization ) and external services ( Stripe, Slack, Google Sheets, Airtable and more ). Once the data sources are connected, ToolJet can run queries on these data sources to fetch and update data. The data fetched from data sources can be visualised and modified using the UI widgets such as tables, charts, forms, etc.
|
||||
slug: /
|
||||
---
|
||||
|
||||
# Introduction
|
||||
|
|
|
|||
|
|
@ -1,6 +1,7 @@
|
|||
---
|
||||
sidebar_position: 3
|
||||
sidebar_label: Security
|
||||
id: security
|
||||
title: Security
|
||||
slug: /security
|
||||
---
|
||||
|
||||
# Security
|
||||
|
|
|
|||
|
|
@ -1,5 +1,6 @@
|
|||
---
|
||||
sidebar_position: 9
|
||||
id: client
|
||||
title: Deploying ToolJet client
|
||||
---
|
||||
|
||||
# Deploying ToolJet client
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
sidebar_position: 2
|
||||
sidebar_label: Docker
|
||||
id: docker
|
||||
title: Docker
|
||||
---
|
||||
|
||||
# Deploying ToolJet using docker-compose
|
||||
|
|
|
|||
|
|
@ -1,5 +1,6 @@
|
|||
---
|
||||
sidebar_position: 4
|
||||
id: ec2
|
||||
title: AWS EC2
|
||||
---
|
||||
|
||||
# AWS EC2
|
||||
|
|
|
|||
|
|
@ -1,5 +1,6 @@
|
|||
---
|
||||
sidebar_position: 10
|
||||
id: env-vars
|
||||
title: Environment variables
|
||||
---
|
||||
|
||||
# Environment variables
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
sidebar_position: 8
|
||||
sidebar_label: Google Cloud Run
|
||||
id: google-cloud-run
|
||||
title: Google Cloud Run
|
||||
---
|
||||
|
||||
# Deploying ToolJet on Google Cloud Run
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
sidebar_position: 3
|
||||
sidebar_label: Heroku
|
||||
id: heroku
|
||||
title: Heroku
|
||||
---
|
||||
|
||||
# Deploying ToolJet on Heroku
|
||||
|
|
|
|||
12
docs/docs/setup/index.md
Normal file
12
docs/docs/setup/index.md
Normal file
|
|
@ -0,0 +1,12 @@
|
|||
# Setup ToolJet
|
||||
|
||||
Check out the different methods you can use to deploy ToolJet on your machine
|
||||
|
||||
```mdx-code-block
|
||||
import DocCardList from '@theme/DocCardList';
|
||||
import {useCurrentSidebarCategory} from '@docusaurus/theme-common';
|
||||
|
||||
<DocCardList items={useCurrentSidebarCategory().items}/>
|
||||
```
|
||||
|
||||
If you have any questions feel free to join our [Slack community](https://join.slack.com/t/tooljet/shared_invite/zt-r2neyfcw-KD1COL6t2kgVTlTtAV5rtg) or send us an email at hello@tooljet.com.
|
||||
|
|
@ -1,12 +1,8 @@
|
|||
---
|
||||
sidebar_position: 1
|
||||
sidebar_label: Architecture
|
||||
id: introduction
|
||||
title: Introduction
|
||||
---
|
||||
|
||||
# Deploying ToolJet
|
||||
 
|
||||
|
||||
## Architecture
|
||||
# Introduction
|
||||
|
||||
ToolJet have two main components: **ToolJet Server** and **ToolJet Client**.
|
||||
|
||||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
sidebar_position: 7
|
||||
sidebar_label: Kubernetes (AKS)
|
||||
id: kubernetes-aks
|
||||
title: Kubernetes (AKS)
|
||||
---
|
||||
|
||||
# Deploying ToolJet on Kubernetes (AKS)
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
sidebar_position: 6
|
||||
sidebar_label: Kubernetes (GKE)
|
||||
id: kubernetes-gke
|
||||
title: Kubernetes (GKE)
|
||||
---
|
||||
|
||||
# Deploying ToolJet on Kubernetes (GKE)
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
sidebar_position: 5
|
||||
sidebar_label: Kubernetes
|
||||
id: kubernetes
|
||||
title: Kubernetes
|
||||
---
|
||||
|
||||
# Deploying ToolJet on Kubernetes
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
sidebar_position: 6
|
||||
sidebar_label: GitHub
|
||||
id: github
|
||||
title: GitHub
|
||||
---
|
||||
|
||||
# GitHub Single Sign-on
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
---
|
||||
sidebar_position: 6
|
||||
sidebar_label: Google
|
||||
id: google
|
||||
title: Google
|
||||
---
|
||||
|
||||
# Google Single Sign-on
|
||||
|
|
|
|||
|
|
@ -1,5 +1,7 @@
|
|||
---
|
||||
sidebar_position: 13
|
||||
id: tracking
|
||||
title: Tracking
|
||||
slug: /tracking
|
||||
---
|
||||
|
||||
# Tracking
|
||||
|
|
@ -1,5 +1,6 @@
|
|||
---
|
||||
sidebar_position: 6
|
||||
id: actions
|
||||
title: Adding actions
|
||||
---
|
||||
|
||||
# Adding actions
|
||||
|
|
|
|||
|
|
@ -1,5 +1,6 @@
|
|||
---
|
||||
sidebar_position: 2
|
||||
id: adding-a-datasource
|
||||
title: Adding a data source
|
||||
---
|
||||
|
||||
# Adding a data source
|
||||
|
|
|
|||
|
|
@ -1,5 +1,6 @@
|
|||
---
|
||||
sidebar_position: 5
|
||||
id: adding-widget
|
||||
title: Adding a widget
|
||||
---
|
||||
|
||||
# Adding a widget
|
||||
|
|
|
|||
|
|
@ -1,5 +1,6 @@
|
|||
---
|
||||
sidebar_position: 3
|
||||
id: building-queries
|
||||
title: Building Queries
|
||||
---
|
||||
|
||||
# Building Queries
|
||||
|
|
|
|||
|
|
@ -1,5 +1,6 @@
|
|||
---
|
||||
sidebar_position: 1
|
||||
id: creating-app
|
||||
title: Creating new app
|
||||
---
|
||||
|
||||
# Creating new app
|
||||
|
|
|
|||
|
|
@ -1,5 +1,6 @@
|
|||
---
|
||||
sidebar_position: 7
|
||||
id: debugger
|
||||
title: Debugger
|
||||
---
|
||||
|
||||
# Debugger
|
||||
|
|
|
|||
|
|
@ -1,5 +1,6 @@
|
|||
---
|
||||
sidebar_position: 12
|
||||
id: keyboard-shortcuts
|
||||
title: Keyboard Shortcuts
|
||||
---
|
||||
|
||||
# Keyboard Shortcuts
|
||||
|
|
|
|||
|
|
@ -1,5 +1,6 @@
|
|||
---
|
||||
sidebar_position: 11
|
||||
id: manage-users-groups
|
||||
title: Managing Users and Groups
|
||||
---
|
||||
|
||||
# Managing Users and Groups
|
||||
|
|
|
|||
|
|
@ -1,5 +1,6 @@
|
|||
---
|
||||
sidebar_position: 8
|
||||
id: mobile-layout
|
||||
title: Mobile layout
|
||||
---
|
||||
|
||||
# Mobile layout
|
||||
|
|
|
|||
|
|
@ -1,5 +1,6 @@
|
|||
---
|
||||
sidebar_position: 10
|
||||
id: sharing-and-deploying
|
||||
title: Preview and Sharing Apps
|
||||
---
|
||||
|
||||
# Preview and Sharing Apps
|
||||
|
|
|
|||
|
|
@ -1,5 +1,6 @@
|
|||
---
|
||||
sidebar_position: 4
|
||||
id: transformations
|
||||
title: Transformations
|
||||
---
|
||||
|
||||
# Transformations
|
||||
|
|
|
|||
|
|
@ -1,5 +1,6 @@
|
|||
---
|
||||
sidebar_position: 9
|
||||
id: versioning-and-release
|
||||
title: Versioning and Release
|
||||
---
|
||||
|
||||
# Versioning and Release
|
||||
|
|
|
|||
|
|
@ -1,3 +1,7 @@
|
|||
---
|
||||
id: button
|
||||
title: Button
|
||||
---
|
||||
# Button
|
||||
|
||||
Button widget can be used to take actions.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,7 @@
|
|||
---
|
||||
id: calendar
|
||||
title: Calendar
|
||||
---
|
||||
# Calendar
|
||||
|
||||
Calendar widget comes with the following features:
|
||||
|
|
|
|||
|
|
@ -1,3 +1,7 @@
|
|||
---
|
||||
id: chart
|
||||
title: Chart
|
||||
---
|
||||
# Chart
|
||||
|
||||
Chart widget takes the chart type, data and styles to draw charts using Plotly.js.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,7 @@
|
|||
---
|
||||
id: checkbox
|
||||
title: Checkbox
|
||||
---
|
||||
# Checkbox
|
||||
|
||||
Checkbox widget can be used for allowing the users to make a binary choice, e.g,. unselected or selected.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,7 @@
|
|||
---
|
||||
id: circular-progress-bar
|
||||
title: Circular Progress Bar
|
||||
---
|
||||
# Circular Progress Bar
|
||||
|
||||
Circular progress bar widget can be used to show progress in a progress circle.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,7 @@
|
|||
---
|
||||
id: code-editor
|
||||
title: Code Editor
|
||||
---
|
||||
# Code Editor
|
||||
|
||||
Code Editor widget is a versatile text editor for editing code and supports several languages.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,7 @@
|
|||
---
|
||||
id: container
|
||||
title: Container
|
||||
---
|
||||
# Container
|
||||
|
||||
Containers are used to group widgets together. You can move the desired number of widgets inside a container to organize your app better.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,7 @@
|
|||
---
|
||||
id: date-range-picker
|
||||
title: Date-range picker
|
||||
---
|
||||
# Date-range picker
|
||||
|
||||
The date-range picker widget allows users to select a range of dates.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,7 @@
|
|||
---
|
||||
id: datepicker
|
||||
title: Datepicker
|
||||
---
|
||||
# Datepicker
|
||||
|
||||
The Datepicker widget allows users to select a single value for date and time from a pre-determined set.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,7 @@
|
|||
---
|
||||
id: divider
|
||||
title: Divider
|
||||
---
|
||||
# Divider
|
||||
|
||||
Divider widget is used to add separator between components.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,7 @@
|
|||
---
|
||||
id: dropdown
|
||||
title: Dropdown
|
||||
---
|
||||
# Dropdown
|
||||
|
||||
The Dropdown widget can be used to collect user input from a list of options.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,7 @@
|
|||
---
|
||||
id: file-picker
|
||||
title: Filepicker
|
||||
---
|
||||
# Filepicker
|
||||
|
||||
Filepicker widget allows the user to drag and drop files or upload files by browsing the filesystem and selecting one or more files in a directory.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,7 @@
|
|||
---
|
||||
id: iframe
|
||||
title: Iframe
|
||||
---
|
||||
# Iframe
|
||||
|
||||
Iframe widget is used to embed another HTML page into the current one and display iframes in your app.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,7 @@
|
|||
---
|
||||
id: image
|
||||
title: Image
|
||||
---
|
||||
# Image
|
||||
|
||||
Image widget is used to display images in your app.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,7 @@
|
|||
---
|
||||
id: listview
|
||||
title: List view
|
||||
---
|
||||
# List view
|
||||
|
||||
List view widget allows to create a list of repeatable rows of data. Just like container widget, you can nest other widgets inside of it and control how many times they repeat.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,7 @@
|
|||
---
|
||||
id: map
|
||||
title: Map
|
||||
---
|
||||
# Map
|
||||
|
||||
The map widget can be used to pick or select locations on the Google map with the location's coordinates.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,7 @@
|
|||
---
|
||||
id: modal
|
||||
title: Modal
|
||||
---
|
||||
# Modal
|
||||
|
||||
Modal widget renders in front of a backdrop, and it blocks interaction with the rest of the application until the modal is closed. It can be used to add dialog boxes to your app for lightboxes, user notifications, forms, etc.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,7 @@
|
|||
---
|
||||
id: multiselect
|
||||
title: Multiselect
|
||||
---
|
||||
# Multiselect
|
||||
|
||||
Multiselect widget can be used to collect multiple user inputs from a list of options.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,7 @@
|
|||
---
|
||||
id: number-input
|
||||
title: Number Input
|
||||
---
|
||||
# Number Input
|
||||
|
||||
Number Input widget lets users enter and change numbers.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,7 @@
|
|||
---
|
||||
id: password-input
|
||||
title: Password Input
|
||||
---
|
||||
# Password Input
|
||||
|
||||
A Password Input widget provides a way for the users to securely enter a password. The Password Input is a one-line plain text editor in which the text is obscured so that it cannot be read, by replacing each character with an asterisk ("*") symbol.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,7 @@
|
|||
---
|
||||
id: qr-scanner
|
||||
title: QR Scanner
|
||||
---
|
||||
# QR Scanner
|
||||
Scan QR codes using device camera and hold the data they carry.
|
||||
|
||||
|
|
|
|||
|
|
@ -1,3 +1,7 @@
|
|||
---
|
||||
id: radio-button
|
||||
title: Radio Button
|
||||
---
|
||||
# Radio Button
|
||||
|
||||
Radio button widget can be used to select one option from a group of options.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,7 @@
|
|||
---
|
||||
id: range-slider
|
||||
title: Range Slider
|
||||
---
|
||||
# Range Slider
|
||||
|
||||
Range sliders are widely used across different UIs. One of the main purposes is to filter, explore all the related content and available in the control and settings options.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,7 @@
|
|||
---
|
||||
id: rich-text-editor
|
||||
title: Rich Text Editor
|
||||
---
|
||||
# Rich Text Editor
|
||||
|
||||
Rich Text Editor can be used to enter and edit the text in HTML format.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,7 @@
|
|||
---
|
||||
id: spinner
|
||||
title: Spinner
|
||||
---
|
||||
# Spinner
|
||||
|
||||
Spinner widget can be used to provide a visual indication that an action is in progress by awaiting a change.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,7 @@
|
|||
---
|
||||
id: star
|
||||
title: Star rating
|
||||
---
|
||||
# Star rating
|
||||
|
||||
Star rating widget can be used to display as well as input ratings. The widget supports half stars, and the number of stars can be set too.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,7 @@
|
|||
---
|
||||
id: statistics
|
||||
title: Statistics
|
||||
---
|
||||
# Statistics
|
||||
|
||||
Statistics can be used to display different statistical information.
|
||||
|
|
|
|||
|
|
@ -1,3 +1,7 @@
|
|||
---
|
||||
id: table
|
||||
title: Table
|
||||
---
|
||||
# Table
|
||||
|
||||
Tables can be used for both displaying and editing data.
|
||||
|
|
|
|||
Some files were not shown because too many files have changed in this diff Show more
Loading…
Reference in a new issue