diff --git a/README.md b/README.md index aec5952469..c8847c5471 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ ToolJet is an **open-source low-code framework** to build and deploy internal tools with minimal engineering effort. ToolJet's drag-and-drop frontend builder allows you to create complex, responsive frontends within minutes. Additionally, you can integrate various data sources, including databases like PostgreSQL, MongoDB, and Elasticsearch; API endpoints with OpenAPI spec and OAuth2 support; SaaS tools such as Stripe, Slack, Google Sheets, Airtable, and Notion; as well as object storage services like S3, GCS, and Minio, to fetch and write data. - :star: If you find ToolJet useful, please consider giving us a star on GitHub! Your support helps us continue to innovate and deliver exciting features. +:star: If you find ToolJet useful, please consider giving us a star on GitHub! Your support helps us continue to innovate and deliver exciting features. ![Docker Cloud Build Status](https://img.shields.io/docker/cloud/build/tooljet/tooljet-ce) ![Number of GitHub contributors](https://img.shields.io/github/contributors/tooljet/tooljet) @@ -35,8 +35,8 @@ ToolJet is an **open-source low-code framework** to build and deploy internal to - **Version control:** Manage multiple application versions with a structured release cycle. - **Run JS & Python code:** Execute custom JavaScript and Python snippets. - **Granular access control:** Set permissions at both group and app levels. -- **Low-code:** Use JS code almost anywhere within the builder, such as setting text color based on status with -`status === 'success' ? 'green' : 'red'`. +- **Low-code:** Use JS code almost anywhere within the builder, such as setting text color based on status with + `status === 'success' ? 'green' : 'red'`. - **No-code query editors:** Query Editors are available for all supported data sources. - **Join and transform data:** Transform query results using JavaScript or Python code. - **Secure:** All the credentials are securely encrypted using `aes-256-gcm`. @@ -46,11 +46,12 @@ ToolJet is an **open-source low-code framework** to build and deploy internal to
## Quickstart + The easiest way to get started with ToolJet is by creating a [ToolJet Cloud](https://tooljet.ai) account. ToolJet Cloud offers a hosted solution of ToolJet. If you want to self-host ToolJet, kindly proceed to [deployment documentation](https://docs.tooljet.ai/docs/setup/). ### Try using Docker -Want to give ToolJet a quick spin on your local machine? You can run the following command from your terminal to have ToolJet up and running right away. +Want to give ToolJet a quick spin on your local machine? You can run the following command from your terminal to have ToolJet up and running right away. ```bash docker run \ @@ -62,7 +63,7 @@ docker run \ tooljet/try:ee-lts-latest ``` -*For users upgrading their ToolJet version, we recommend choosing the LTS version over the latest version. The LTS version ensures stability with production bug fixes, security patches, and performance enhancements.* +_For users upgrading their ToolJet version, we recommend choosing the LTS version over the latest version. The LTS version ensures stability with production bug fixes, security patches, and performance enhancements._ ## Tutorials and examples @@ -71,6 +72,7 @@ docker run \ [AWS S3 Browser](https://blog.tooljet.ai/build-an-aws-s3-broswer-with-tooljet/)
## Documentation + Documentation is available at https://docs.tooljet.ai. - [Getting Started](https://docs.tooljet.ai)
@@ -78,30 +80,33 @@ Documentation is available at https://docs.tooljet.ai. - [Component Reference](https://docs.tooljet.ai/docs/widgets/button) ## Self-hosted + You can use ToolJet Cloud for a fully managed solution. If you want to self-host ToolJet, we have guides on deploying ToolJet on Kubernetes, AWS EC2, Docker, and more. -| Provider | Documentation | -| :------------- | :------------- | -| Digital Ocean | [Link](https://docs.tooljet.ai/docs/setup/digitalocean) | -| Docker | [Link](https://docs.tooljet.ai/docs/setup/docker) | -| AWS EC2 | [Link](https://docs.tooljet.ai/docs/setup/ec2) | -| AWS ECS | [Link](https://docs.tooljet.ai/docs/setup/ecs) | -| OpenShift | [Link](https://docs.tooljet.ai/docs/setup/openshift) | -| Helm | [Link](https://docs.tooljet.ai/docs/setup/helm) | -| AWS EKS (Kubernetes) | [Link](https://docs.tooljet.ai/docs/setup/kubernetes) | -| GCP GKE (Kubernetes) | [Link](https://docs.tooljet.ai/docs/setup/kubernetes-gke) | -| Azure AKS (Kubernetes) | [Link](https://docs.tooljet.ai/docs/setup/kubernetes-aks) | -| Azure Container | [Link](https://docs.tooljet.ai/docs/setup/azure-container) | -| Google Cloud Run | [Link](https://docs.tooljet.ai/docs/setup/google-cloud-run) | -| Deploying ToolJet client | [Link](https://docs.tooljet.ai/docs/setup/client) | -| Deploying ToolJet on a Subpath | [Link](https://docs.tooljet.ai/docs/setup/tooljet-subpath/) | +| Provider | Documentation | +| :----------------------------- | :---------------------------------------------------------- | +| Digital Ocean | [Link](https://docs.tooljet.ai/docs/setup/digitalocean) | +| Docker | [Link](https://docs.tooljet.ai/docs/setup/docker) | +| AWS EC2 | [Link](https://docs.tooljet.ai/docs/setup/ami) | +| AWS ECS | [Link](https://docs.tooljet.ai/docs/setup/ecs) | +| OpenShift | [Link](https://docs.tooljet.ai/docs/setup/openshift) | +| Helm | [Link](https://docs.tooljet.ai/docs/setup/helm) | +| AWS EKS (Kubernetes) | [Link](https://docs.tooljet.ai/docs/setup/kubernetes) | +| GCP GKE (Kubernetes) | [Link](https://docs.tooljet.ai/docs/setup/kubernetes-gke) | +| Azure AKS (Kubernetes) | [Link](https://docs.tooljet.ai/docs/setup/kubernetes-aks) | +| Azure Container | [Link](https://docs.tooljet.ai/docs/setup/azure-container) | +| Google Cloud Run | [Link](https://docs.tooljet.ai/docs/setup/google-cloud-run) | +| Deploying ToolJet client | [Link](https://docs.tooljet.ai/docs/setup/client) | +| Deploying ToolJet on a Subpath | [Link](https://docs.tooljet.ai/docs/setup/tooljet-subpath/) | + +## Marketplace -## Marketplace ToolJet can now be found on both AWS and Azure Marketplaces, making it simpler than ever to access and deploy our app-building platform. Find ToolJet on AWS Marketplace [here](https://aws.amazon.com/marketplace/pp/prodview-fxjto27jkpqfg?sr=0-1&ref_=beagle&applicationId=AWSMPContessa) and explore seamless integration on Azure Marketplace [here](https://azuremarketplace.microsoft.com/en-us/marketplace/apps/tooljetsolutioninc1679496832216.tooljet?tab=Overview). ## Community support + For general help using ToolJet, please refer to the official [documentation](https://docs.tooljet.ai/docs/). For additional help, you can use one of these channels to ask a question: - [Slack](https://tooljet.ai/slack) - Discussions with the community and the team. @@ -109,19 +114,24 @@ For general help using ToolJet, please refer to the official [documentation](htt - [𝕏 (Twitter)](https://twitter.com/ToolJet) - Get the product updates quickly. ## Roadmap + Check out our [roadmap](https://github.com/orgs/ToolJet/projects/15) to stay updated on recently released features and learn about what's coming next. ## Branching model + We use the git-flow branching model. The base branch is `develop`. If you are looking for a stable version, please use the main branch or tags labeled as v1.x.x. ## Contributing + Kindly read our [Contributing Guide](CONTRIBUTING.md) to familiarize yourself with ToolJet's development process, how to suggest bug fixes and improvements, and the steps for building and testing your changes.
## Contributors + ## License + ToolJet © 2023, ToolJet Solutions Inc - Released under the GNU Affero General Public License v3.0. diff --git a/docs/docs/homePageData.js b/docs/docs/homePageData.js index 52e8db770a..c2f9499266 100644 --- a/docs/docs/homePageData.js +++ b/docs/docs/homePageData.js @@ -70,7 +70,7 @@ export const setupCards = [ export const deployOptions = [ { icon: Cloud, title: "DigitalOcean", href: "/docs/beta/setup/digitalocean" }, { icon: Container, title: "Docker", href: "/docs/beta/setup/docker" }, - { icon: Server, title: "AWS EC2", href: "/docs/beta/setup/ec2" }, + { icon: Server, title: "AWS EC2", href: "/docs/beta/setup/ami" }, { icon: Server, title: "AWS ECS", href: "/docs/beta/setup/ecs" }, { icon: Server, title: "Openshift", href: "/docs/beta/setup/openshift" }, { icon: Telescope, title: "Helm", href: "/docs/beta/setup/helm" }, diff --git a/docs/docs/setup/ec2.md b/docs/docs/setup/ami.md similarity index 99% rename from docs/docs/setup/ec2.md rename to docs/docs/setup/ami.md index 10d94327ea..55e65ccef5 100644 --- a/docs/docs/setup/ec2.md +++ b/docs/docs/setup/ami.md @@ -1,9 +1,9 @@ --- -id: ec2 -title: AWS EC2 +id: ami +title: AWS AMI --- -# Deploying ToolJet on Amazon EC2 +# Deploying ToolJet on Amazon AMI :::info You should setup a PostgreSQL database manually to be used by the ToolJet server. diff --git a/docs/docs/setup/upgrade-to-lts.md b/docs/docs/setup/upgrade-to-lts.md index 0df918a9be..6584343ea1 100644 --- a/docs/docs/setup/upgrade-to-lts.md +++ b/docs/docs/setup/upgrade-to-lts.md @@ -1,7 +1,6 @@ --- id: upgrade-to-lts title: Upgrading ToolJet to the LTS Version - --- ToolJet has released its first Long Term Support (LTS) version, which provides extended support and stability for your environments. Upgrading to this LTS version ensures you benefit from the latest features and security updates while maintaining a stable and supported environment. @@ -22,7 +21,7 @@ The upgrade process depends on your deployment method. You can follow the upgrad - [Upgrade ToolJet on DigitalOcean](/docs/setup/digitalocean#upgrading-to-the-latest-lts-version) - [Upgrade ToolJet on Docker](/docs/setup/docker#upgrading-to-the-latest-lts-version) -- [Upgrade ToolJet on AWS EC2](/docs/setup/ec2#upgrading-to-the-latest-lts-version) +- [Upgrade ToolJet on AWS EC2](/docs/setup/ami#upgrading-to-the-latest-lts-version) - [Upgrade ToolJet on AWS ECS](/docs/setup/ecs#upgrading-to-the-latest-lts-version) - [Upgrade ToolJet on OpenShift](/docs/setup/openshift#upgrading-to-the-latest-lts-version) - [Upgrade ToolJet on Helm](/docs/setup/helm#upgrading-to-the-latest-lts-version) @@ -31,4 +30,3 @@ The upgrade process depends on your deployment method. You can follow the upgrad - [Upgrade ToolJet on Kubernetes(AKS)](/docs/setup/kubernetes-aks#upgrading-to-the-latest-lts-version) - [Upgrade ToolJet on Azure Container Apps](/docs/setup/azure-container#upgrading-to-the-latest-lts-version) - [Upgrade ToolJet on Google Cloud Run](/docs/setup/google-cloud-run#upgrading-to-the-latest-lts-version) - diff --git a/docs/sidebars.js b/docs/sidebars.js index 9cdbe2fb40..11ddc307be 100644 --- a/docs/sidebars.js +++ b/docs/sidebars.js @@ -90,7 +90,7 @@ const sidebars = { 'setup/system-requirements', 'setup/digitalocean', 'setup/docker', - 'setup/ec2', + 'setup/ami', 'setup/ecs', 'setup/openshift', 'setup/helm', diff --git a/docs/versioned_docs/version-2.50.0-LTS/setup/ec2.md b/docs/versioned_docs/version-2.50.0-LTS/setup/ami.md similarity index 98% rename from docs/versioned_docs/version-2.50.0-LTS/setup/ec2.md rename to docs/versioned_docs/version-2.50.0-LTS/setup/ami.md index 54999ce9fb..e965d599f3 100644 --- a/docs/versioned_docs/version-2.50.0-LTS/setup/ec2.md +++ b/docs/versioned_docs/version-2.50.0-LTS/setup/ami.md @@ -1,9 +1,9 @@ --- -id: ec2 -title: AWS EC2 +id: ami +title: AWS AMI --- -# Deploying ToolJet on Amazon EC2 +# Deploying ToolJet on Amazon AMI :::info You should setup a PostgreSQL database manually to be used by the ToolJet server. diff --git a/docs/versioned_docs/version-2.50.0-LTS/setup/upgrade-to-lts.md b/docs/versioned_docs/version-2.50.0-LTS/setup/upgrade-to-lts.md index 1ffadd0edf..78b2c4cbcf 100644 --- a/docs/versioned_docs/version-2.50.0-LTS/setup/upgrade-to-lts.md +++ b/docs/versioned_docs/version-2.50.0-LTS/setup/upgrade-to-lts.md @@ -1,7 +1,6 @@ --- id: upgrade-to-lts title: Upgrading ToolJet to the LTS Version - --- ToolJet has released its first Long Term Support (LTS) version, which provides extended support and stability for your environments. Upgrading to this LTS version ensures you benefit from the latest features and security updates while maintaining a stable and supported environment. @@ -22,7 +21,7 @@ The upgrade process depends on your deployment method. You can follow the upgrad - [Upgrade ToolJet on DigitalOcean](/docs/2.50.0-lts/setup/digitalocean#upgrading-to-the-latest-lts-version) - [Upgrade ToolJet on Docker](/docs/2.50.0-lts/setup/docker#upgrading-to-the-latest-lts-version) -- [Upgrade ToolJet on AWS EC2](/docs/2.50.0-lts/setup/ec2#upgrading-to-the-latest-lts-version) +- [Upgrade ToolJet on AWS EC2](/docs/2.50.0-lts/setup/ami#upgrading-to-the-latest-lts-version) - [Upgrade ToolJet on AWS ECS](/docs/2.50.0-lts/setup/ecs#upgrading-to-the-latest-lts-version) - [Upgrade ToolJet on OpenShift](/docs/2.50.0-lts/setup/openshift#upgrading-to-the-latest-lts-version) - [Upgrade ToolJet on Helm](/docs/2.50.0-lts/setup/helm#upgrading-to-the-latest-lts-version) diff --git a/docs/versioned_docs/version-3.0.0-LTS/homePageData.js b/docs/versioned_docs/version-3.0.0-LTS/homePageData.js index 353946c71b..a9b72a6e98 100644 --- a/docs/versioned_docs/version-3.0.0-LTS/homePageData.js +++ b/docs/versioned_docs/version-3.0.0-LTS/homePageData.js @@ -63,7 +63,7 @@ export const setupCards = [ export const deployOptions = [ { icon: Cloud, title: "DigitalOcean", href: "/docs/3.0.0-LTS/setup/digitalocean" }, { icon: Container, title: "Docker", href: "/docs/3.0.0-LTS/setup/docker" }, - { icon: Server, title: "AWS EC2", href: "/docs/3.0.0-LTS/setup/ec2" }, + { icon: Server, title: "AWS EC2", href: "/docs/3.0.0-LTS/setup/ami" }, { icon: Server, title: "AWS ECS", href: "/docs/3.0.0-LTS/setup/ecs" }, { icon: Server, title: "Openshift", href: "/docs/3.0.0-LTS/setup/openshift" }, { icon: Telescope, title: "Helm", href: "/docs/3.0.0-LTS/setup/helm" }, diff --git a/docs/versioned_docs/version-3.0.0-LTS/setup/ec2.md b/docs/versioned_docs/version-3.0.0-LTS/setup/ami.md similarity index 98% rename from docs/versioned_docs/version-3.0.0-LTS/setup/ec2.md rename to docs/versioned_docs/version-3.0.0-LTS/setup/ami.md index e8ebfb1902..3a48487e00 100644 --- a/docs/versioned_docs/version-3.0.0-LTS/setup/ec2.md +++ b/docs/versioned_docs/version-3.0.0-LTS/setup/ami.md @@ -1,9 +1,9 @@ --- -id: ec2 -title: AWS EC2 +id: ami +title: AWS AMI --- -# Deploying ToolJet on Amazon EC2 +# Deploying ToolJet on Amazon AMI :::info You should setup a PostgreSQL database manually to be used by the ToolJet server. diff --git a/docs/versioned_docs/version-3.0.0-LTS/setup/upgrade-to-lts.md b/docs/versioned_docs/version-3.0.0-LTS/setup/upgrade-to-lts.md index 0df918a9be..6584343ea1 100644 --- a/docs/versioned_docs/version-3.0.0-LTS/setup/upgrade-to-lts.md +++ b/docs/versioned_docs/version-3.0.0-LTS/setup/upgrade-to-lts.md @@ -1,7 +1,6 @@ --- id: upgrade-to-lts title: Upgrading ToolJet to the LTS Version - --- ToolJet has released its first Long Term Support (LTS) version, which provides extended support and stability for your environments. Upgrading to this LTS version ensures you benefit from the latest features and security updates while maintaining a stable and supported environment. @@ -22,7 +21,7 @@ The upgrade process depends on your deployment method. You can follow the upgrad - [Upgrade ToolJet on DigitalOcean](/docs/setup/digitalocean#upgrading-to-the-latest-lts-version) - [Upgrade ToolJet on Docker](/docs/setup/docker#upgrading-to-the-latest-lts-version) -- [Upgrade ToolJet on AWS EC2](/docs/setup/ec2#upgrading-to-the-latest-lts-version) +- [Upgrade ToolJet on AWS EC2](/docs/setup/ami#upgrading-to-the-latest-lts-version) - [Upgrade ToolJet on AWS ECS](/docs/setup/ecs#upgrading-to-the-latest-lts-version) - [Upgrade ToolJet on OpenShift](/docs/setup/openshift#upgrading-to-the-latest-lts-version) - [Upgrade ToolJet on Helm](/docs/setup/helm#upgrading-to-the-latest-lts-version) @@ -31,4 +30,3 @@ The upgrade process depends on your deployment method. You can follow the upgrad - [Upgrade ToolJet on Kubernetes(AKS)](/docs/setup/kubernetes-aks#upgrading-to-the-latest-lts-version) - [Upgrade ToolJet on Azure Container Apps](/docs/setup/azure-container#upgrading-to-the-latest-lts-version) - [Upgrade ToolJet on Google Cloud Run](/docs/setup/google-cloud-run#upgrading-to-the-latest-lts-version) - diff --git a/docs/versioned_docs/version-3.5.0-LTS/homePageData.js b/docs/versioned_docs/version-3.5.0-LTS/homePageData.js index 97f976f3b3..88eab72d20 100644 --- a/docs/versioned_docs/version-3.5.0-LTS/homePageData.js +++ b/docs/versioned_docs/version-3.5.0-LTS/homePageData.js @@ -70,7 +70,7 @@ export const setupCards = [ export const deployOptions = [ { icon: Cloud, title: "DigitalOcean", href: "/docs/setup/digitalocean" }, { icon: Container, title: "Docker", href: "/docs/setup/docker" }, - { icon: Server, title: "AWS EC2", href: "/docs/setup/ec2" }, + { icon: Server, title: "AWS EC2", href: "/docs/setup/ami" }, { icon: Server, title: "AWS ECS", href: "/docs/setup/ecs" }, { icon: Server, title: "Openshift", href: "/docs/setup/openshift" }, { icon: Telescope, title: "Helm", href: "/docs/setup/helm" }, diff --git a/docs/versioned_docs/version-3.5.0-LTS/setup/ec2.md b/docs/versioned_docs/version-3.5.0-LTS/setup/ami.md similarity index 99% rename from docs/versioned_docs/version-3.5.0-LTS/setup/ec2.md rename to docs/versioned_docs/version-3.5.0-LTS/setup/ami.md index 9a6563e5b3..745a7507b0 100644 --- a/docs/versioned_docs/version-3.5.0-LTS/setup/ec2.md +++ b/docs/versioned_docs/version-3.5.0-LTS/setup/ami.md @@ -1,9 +1,9 @@ --- -id: ec2 -title: AWS EC2 +id: ami +title: AWS AMI --- -# Deploying ToolJet on Amazon EC2 +# Deploying ToolJet on Amazon AMI :::warning To enable ToolJet AI features in your ToolJet deployment, whitelist https://api-gateway.tooljet.ai. diff --git a/docs/versioned_docs/version-3.5.0-LTS/setup/upgrade-to-lts.md b/docs/versioned_docs/version-3.5.0-LTS/setup/upgrade-to-lts.md index 0df918a9be..6584343ea1 100644 --- a/docs/versioned_docs/version-3.5.0-LTS/setup/upgrade-to-lts.md +++ b/docs/versioned_docs/version-3.5.0-LTS/setup/upgrade-to-lts.md @@ -1,7 +1,6 @@ --- id: upgrade-to-lts title: Upgrading ToolJet to the LTS Version - --- ToolJet has released its first Long Term Support (LTS) version, which provides extended support and stability for your environments. Upgrading to this LTS version ensures you benefit from the latest features and security updates while maintaining a stable and supported environment. @@ -22,7 +21,7 @@ The upgrade process depends on your deployment method. You can follow the upgrad - [Upgrade ToolJet on DigitalOcean](/docs/setup/digitalocean#upgrading-to-the-latest-lts-version) - [Upgrade ToolJet on Docker](/docs/setup/docker#upgrading-to-the-latest-lts-version) -- [Upgrade ToolJet on AWS EC2](/docs/setup/ec2#upgrading-to-the-latest-lts-version) +- [Upgrade ToolJet on AWS EC2](/docs/setup/ami#upgrading-to-the-latest-lts-version) - [Upgrade ToolJet on AWS ECS](/docs/setup/ecs#upgrading-to-the-latest-lts-version) - [Upgrade ToolJet on OpenShift](/docs/setup/openshift#upgrading-to-the-latest-lts-version) - [Upgrade ToolJet on Helm](/docs/setup/helm#upgrading-to-the-latest-lts-version) @@ -31,4 +30,3 @@ The upgrade process depends on your deployment method. You can follow the upgrad - [Upgrade ToolJet on Kubernetes(AKS)](/docs/setup/kubernetes-aks#upgrading-to-the-latest-lts-version) - [Upgrade ToolJet on Azure Container Apps](/docs/setup/azure-container#upgrading-to-the-latest-lts-version) - [Upgrade ToolJet on Google Cloud Run](/docs/setup/google-cloud-run#upgrading-to-the-latest-lts-version) - diff --git a/docs/versioned_sidebars/version-2.50.0-LTS-sidebars.json b/docs/versioned_sidebars/version-2.50.0-LTS-sidebars.json index 6277acd842..b8deb13005 100644 --- a/docs/versioned_sidebars/version-2.50.0-LTS-sidebars.json +++ b/docs/versioned_sidebars/version-2.50.0-LTS-sidebars.json @@ -44,7 +44,7 @@ "setup/system-requirements", "setup/digitalocean", "setup/docker", - "setup/ec2", + "setup/ami", "setup/ecs", "setup/openshift", "setup/helm", diff --git a/docs/versioned_sidebars/version-3.0.0-LTS-sidebars.json b/docs/versioned_sidebars/version-3.0.0-LTS-sidebars.json index b9ebe9b4d6..4a7c3b82bd 100644 --- a/docs/versioned_sidebars/version-3.0.0-LTS-sidebars.json +++ b/docs/versioned_sidebars/version-3.0.0-LTS-sidebars.json @@ -44,7 +44,7 @@ "setup/system-requirements", "setup/digitalocean", "setup/docker", - "setup/ec2", + "setup/ami", "setup/ecs", "setup/openshift", "setup/helm", diff --git a/docs/versioned_sidebars/version-3.5.0-LTS-sidebars.json b/docs/versioned_sidebars/version-3.5.0-LTS-sidebars.json index 2ce8c1e8b4..0ca068c90e 100644 --- a/docs/versioned_sidebars/version-3.5.0-LTS-sidebars.json +++ b/docs/versioned_sidebars/version-3.5.0-LTS-sidebars.json @@ -80,7 +80,7 @@ "setup/system-requirements", "setup/digitalocean", "setup/docker", - "setup/ec2", + "setup/ami", "setup/ecs", "setup/openshift", "setup/helm",