mirror of
https://github.com/ToolJet/ToolJet
synced 2026-05-24 09:28:31 +00:00
[docs]: Setup Update for V3 (#11290)
* updated ecs * updated kuernetes * ecs done * Updated Setup Docs * update google cloud run * new update * Updated env var * Updated changes in 3.0.0 * update azure container * updated the docker image in 3.0.0 * update env var and tj db
This commit is contained in:
Pratik Agrawal
GitHub
parent
148f0175fb
commit
c9b01096f0
63 changed files with 738 additions and 863 deletions
|
|
@ -9,8 +9,6 @@ title: Azure container apps
|
|||
Please note that you need to set up a PostgreSQL database manually to be used by ToolJet. Additionally, you must set up a Redis service through Azure Cache for Redis.
|
||||
:::
|
||||
|
||||
*If you have any questions feel free to join our [Slack Community](https://tooljet.com/slack) or send us an email at hello@tooljet.com.*
|
||||
|
||||
## Deploying ToolJet application
|
||||
|
||||
1. Open the Azure dashboard at https://portal.azure.com, navigate to Container Apps, and click on "Create container app".
|
||||
|
|
@ -35,9 +33,19 @@ Please note that you need to set up a PostgreSQL database manually to be used by
|
|||
</div>
|
||||
|
||||
- Make sure to provide the image tag, and then enter `server/entrypoint.sh, npm, run, start:prod` in the "Command override" field.
|
||||
- Add the following ToolJet application variables under the "Environmental variable" section. You can refer to this [**documentation**](/docs/setup/env-vars) for more information on environment variables.
|
||||
- Add the following ToolJet application variables under the "Environmental variable" section. You can refer to this [**documentation**](./env-vars) for more information on environment variables.
|
||||
|
||||
**Note: For the minimal setup, ToolJet requires: `TOOLJET_HOST`, `PG_HOST`, `PG_DB`, `PG_USER`, `PG_PASSWORD`, `SECRET_KEY_BASE` & `LOCKBOX_MASTER_KEY` keys in the secret.**
|
||||
**Note**: ToolJet requires:
|
||||
- **TOOLJET_DB**
|
||||
- **TOOLJET_DB_HOST**
|
||||
- **TOOLJET_DB_USER**
|
||||
- **TOOLJET_DB_PASS**
|
||||
- **PG_HOST**
|
||||
- **PG_DB**
|
||||
- **PG_USER**
|
||||
- **PG_PASS**
|
||||
- **SECRET_KEY_BASE**
|
||||
- **LOCKBOX_KEY**
|
||||
|
||||
<div style={{textAlign: 'center'}}>
|
||||
|
||||
|
|
@ -119,5 +127,4 @@ If this is a new installation of the application, you may start directly with th
|
|||
|
||||
- Users on versions earlier than **v2.23.0-ee2.10.2** must first upgrade to this version before proceeding to the LTS version.
|
||||
|
||||
For specific issues or questions, refer to our **[Slack](https://tooljet.slack.com/join/shared_invite/zt-25438diev-mJ6LIZpJevG0LXCEcL0NhQ#)**.
|
||||
|
||||
*If you have any questions feel free to join our [Slack Community](https://tooljet.com/slack) or send us an email at hello@tooljet.com.*
|
||||
|
|
|
|||
|
|
@ -7,8 +7,6 @@ title: DigitalOcean
|
|||
|
||||
Now you can quickly deploy ToolJet using the Deploy to DigitalOcean button.
|
||||
|
||||
If you have any questions feel free to join our [Slack Community](https://tooljet.com/slack) or send us an email at hello@tooljet.com.
|
||||
|
||||
### Redis setup
|
||||
|
||||
:::info
|
||||
|
|
@ -37,7 +35,7 @@ Follow the steps below to configure Redis database:
|
|||
|
||||
## Deploying
|
||||
|
||||
#### Follow the steps below to deploy ToolJet on DigitalOcean:
|
||||
#### Follow the Steps Below to Deploy ToolJet on DigitalOcean:
|
||||
|
||||
1. Click on the button below to start one click deployment
|
||||
|
||||
|
|
@ -89,8 +87,11 @@ ToolJet server and client can be deployed as standalone applications. If you do
|
|||
|
||||
## Deploying ToolJet Database
|
||||
|
||||
If you intend to use this feature, you'd have to set up and deploy PostgREST server which helps querying ToolJet Database.
|
||||
You can learn more about this feature [here](/docs/tooljet-database).
|
||||
To use ToolJet Database, you'd have to set up and deploy PostgREST server which helps querying ToolJet Database.
|
||||
You can learn more about this feature [here](../tooljet-db/tooljet-database).
|
||||
|
||||
Deploying ToolJet Database is mandatory from ToolJet 3.0 or else the migration might break, checkout the following docs to know more about new major version, including breaking changes that require you to adjust your applications accordingly:
|
||||
- [Self Hosted](./upgrade-to-v3.md)
|
||||
|
||||
Follow the steps below to deploy ToolJet Database on DigitalOcean:
|
||||
|
||||
|
|
@ -120,4 +121,4 @@ If this is a new installation of the application, you may start directly with th
|
|||
|
||||
- Users on versions earlier than **v2.23.0-ee2.10.2** must first upgrade to this version before proceeding to the LTS version.
|
||||
|
||||
For specific issues or questions, refer to our **[Slack](https://tooljet.slack.com/join/shared_invite/zt-25438diev-mJ6LIZpJevG0LXCEcL0NhQ#)**.
|
||||
If you have any questions feel free to join our [Slack Community](https://tooljet.com/slack) or send us an email at hello@tooljet.com.
|
||||
|
|
|
|||
|
|
@ -9,8 +9,6 @@ title: AWS EC2
|
|||
You should setup a PostgreSQL database manually to be used by the ToolJet server.
|
||||
:::
|
||||
|
||||
*If you have any questions feel free to join our [Slack Community](https://tooljet.com/slack) or send us an email at hello@tooljet.com.*
|
||||
|
||||
You can effortlessly deploy Amazon Elastic Compute Cloud Service (EC2) by utilizing a **CloudFormation template**. This template will deploy all the services required to run ToolJet on AWS EC2 instances.
|
||||
|
||||
To deploy all the services at once, simply employ the following template:
|
||||
|
|
@ -21,16 +19,11 @@ curl -LO https://tooljet-deployments.s3.us-west-1.amazonaws.com/cloudformation/E
|
|||
Follow the steps below to deploy ToolJet on AWS EC2 instances.
|
||||
|
||||
1. Setup a PostgreSQL database and make sure that the database is accessible from the EC2 instance.
|
||||
|
||||
2. Login to your AWS management console and go to the EC2 management page.
|
||||
|
||||
3. Under the `Images` section, click on the `AMIs` button.
|
||||
|
||||
3. Under the **Images** section, click on the **AMIs** button.
|
||||
4. Find the [ToolJet version](https://github.com/ToolJet/ToolJet/releases) you want to deploy. Now, from the AMI search page, select the search type as "Public Images" and input the version you'd want `AMI Name : tooljet_vX.X.X.ubuntu_bionic` in the search bar.
|
||||
|
||||
5. Select ToolJet's AMI and bootup an EC2 instance.
|
||||
|
||||
Creating a new security group is recommended. For example, if the installation should receive traffic from the internet, the inbound rules of the security group should look like this:
|
||||
5. Select ToolJet's AMI and bootup an EC2 instance. <br/>
|
||||
Creating a new security group is recommended. For example, if the installation should receive traffic from the internet, the inbound rules of the security group should look like this:
|
||||
|
||||
protocol| port | allowed_cidr|
|
||||
----| ----------- | ----------- |
|
||||
|
|
@ -39,19 +32,22 @@ Follow the steps below to deploy ToolJet on AWS EC2 instances.
|
|||
tcp | 443 | 0.0.0.0/0 |
|
||||
|
||||
|
||||
6. Once the instance boots up, SSH into the instance by running `ssh -i <path_to_pem_file> ubuntu@<public_ip_of_the_instance>`
|
||||
6. Once the instance boots up, SSH into the instance by running `ssh -i <path_to_pem_file> ubuntu@<public_ip_of_the_instance>`.
|
||||
|
||||
7. Switch to the app directory by running `cd ~/app`. Modify the contents of the `.env` file. ( Eg: `vim .env` )
|
||||
7. Switch to the app directory by running `cd ~/app`. <br/> Modify the contents of the `.env` file. ( Eg: `vim .env` )
|
||||
|
||||
The default `.env` file looks like this:
|
||||
```bash
|
||||
TOOLJET_HOST=http://<example>
|
||||
LOCKBOX_MASTER_KEY=<example>
|
||||
SECRET_KEY_BASE=<example>
|
||||
PG_DB=tooljet_prod
|
||||
PG_USER=<pg user name>
|
||||
PG_HOST=<pg host>
|
||||
PG_PASS=<pg user password>
|
||||
LOCKBOX_MASTER_KEY=
|
||||
SECRET_KEY_BASE=
|
||||
PG_DB=
|
||||
PG_USER=
|
||||
PG_HOST=
|
||||
PG_PASS=
|
||||
TOOLJET_DB=
|
||||
TOOLJET_DB_HOST=
|
||||
TOOLJET_DB_USER=
|
||||
TOOLJET_DB_PASS=
|
||||
```
|
||||
Read **[environment variables reference](/docs/setup/env-vars)**
|
||||
|
||||
|
|
@ -59,32 +55,30 @@ Follow the steps below to deploy ToolJet on AWS EC2 instances.
|
|||
If there are self signed HTTPS endpoints that ToolJet needs to connect to, please make sure that `NODE_EXTRA_CA_CERTS` environment variable is set to the absolute path containing the certificates.
|
||||
:::
|
||||
|
||||
8. `TOOLJET_HOST` environment variable determines where you can access the ToolJet client. It can either be the public ipv4 address of your instance or a custom domain that you want to use.
|
||||
8. `TOOLJET_DB_HOST` environment variable determines where you can access the ToolJet client. It can either be the public ipv4 address of your instance or a custom domain that you want to use.
|
||||
|
||||
Examples:
|
||||
`TOOLJET_HOST=http://12.34.56.78` or
|
||||
`TOOLJET_HOST=https://yourdomain.com` or
|
||||
`TOOLJET_HOST=https://tooljet.yourdomain.com`
|
||||
`TOOLJET_DB_HOST=http://12.34.56.78` or
|
||||
`TOOLJET_DB_HOST=https://yourdomain.com` or
|
||||
`TOOLJET_DB_HOST=https://tooljet.yourdomain.com`
|
||||
|
||||
:::info
|
||||
We use a [lets encrypt](https://letsencrypt.org/) plugin on top of nginx to create TLS certificates on the fly.
|
||||
:::
|
||||
|
||||
:::info
|
||||
Please make sure that `TOOLJET_HOST` starts with either `http://` or `https://`
|
||||
Please make sure that `TOOLJET_DB_HOST` starts with either `http://` or `https://`
|
||||
:::
|
||||
|
||||
9. Once you've configured the `.env` file, run `./setup_app`. This script will install all the dependencies of ToolJet and then will start the required services.
|
||||
|
||||
10. If you've set a custom domain for `TOOLJET_HOST`, add a `A record` entry in your DNS settings to point to the IP address of the EC2 instance.
|
||||
|
||||
12. You're all done, ToolJet client would now be served at the value you've set in `TOOLJET_HOST`.
|
||||
|
||||
#### Deploying ToolJet Database
|
||||
|
||||
ToolJet AMI comes inbuilt with PostgREST. If you intend to use this feature, you'd only have to setup the environment variables in `~/app/.env` file and run `./setup_app` script.
|
||||
|
||||
You can learn more about this feature [here](/docs/tooljet-database).
|
||||
You can learn more about this feature [here](../tooljet-db/tooljet-database).
|
||||
|
||||
## Upgrading to the Latest LTS Version
|
||||
|
||||
|
|
@ -98,10 +92,4 @@ If this is a new installation of the application, you may start directly with th
|
|||
|
||||
- Users on versions earlier than **v2.23.0-ee2.10.2** must first upgrade to this version before proceeding to the LTS version.
|
||||
|
||||
For specific issues or questions, refer to our **[Slack](https://tooljet.slack.com/join/shared_invite/zt-25438diev-mJ6LIZpJevG0LXCEcL0NhQ#)**.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
*If you have any questions feel free to join our [Slack Community](https://tooljet.com/slack) or send us an email at hello@tooljet.com.*
|
||||
|
|
|
|||
|
|
@ -23,6 +23,8 @@ If you already have existing services and wish to integrate ToolJet seamlessly i
|
|||
curl -LO https://tooljet-deployments.s3.us-west-1.amazonaws.com/cloudformation/Cloudformation-deploy.yml
|
||||
```
|
||||
|
||||
<div style={{paddingTop:'24px'}}>
|
||||
|
||||
## Redis
|
||||
|
||||
:::info
|
||||
|
|
@ -34,144 +36,97 @@ To deploy Redis on an ECS cluster, please follow the steps outlined below.
|
|||
Please note that if you already have an existing Redis setup, you can continue using it. However, if you need to create a new Redis service, you can follow the steps provided below.
|
||||
|
||||
- Create a new take definition
|
||||
|
||||
<div style={{textAlign: 'center'}}>
|
||||
|
||||
<img className="screenshot-full" src="/img/setup/ecs/ecs-1.png" alt="ECS Setup" />
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
- Please add container and image tag as shown below:
|
||||
|
||||
- Please add container and image tag as shown below: <br/>
|
||||
**Make sure that you are using redis version 6.x.x**
|
||||
|
||||
<div style={{textAlign: 'center'}}>
|
||||
|
||||
<img className="screenshot-full" src="/img/setup/ecs/ecs-2.png" alt="ECS Setup" />
|
||||
|
||||
</div>
|
||||
|
||||
- Ensure that when creating a service, Redis is integrated into the same cluster where your ToolJet app will be deployed.
|
||||
|
||||
- Ensure that when creating a service, Redis is integrated into the same cluster where your ToolJet app will be deployed. <br/>
|
||||
**Note: Please enable public IP**
|
||||
|
||||
<div style={{textAlign: 'center'}}>
|
||||
|
||||
<img className="screenshot-full" src="/img/setup/ecs/ecs-3.png" alt="ECS Setup" />
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div style={{paddingTop:'24px'}}>
|
||||
|
||||
## ToolJet
|
||||
|
||||
Follow the steps below to deploy ToolJet on a ECS cluster.
|
||||
|
||||
1. Setup a PostgreSQL database ToolJet uses a postgres database as the persistent storage for storing data related to users and apps.
|
||||
1. Setup a PostgreSQL database, ToolJet uses a postgres database as the persistent storage for storing data related to users and apps.
|
||||
2. Create a target group and an application load balancer to route traffic onto ToolJet containers. You can [reference](https://docs.aws.amazon.com/AmazonECS/latest/userguide/create-application-load-balancer.html) AWS docs to set it up. Please note that ToolJet server exposes `/api/health`, which you can configure for health checks.
|
||||
|
||||
3. Create task definition for deploying ToolJet app as a service on your preconfigured cluster.
|
||||
1. Select Fargate as launch type compatibility
|
||||
2. Configure IAM roles and set operating system family as Linux.
|
||||
3. Select task size to have 3GB of memory and 1vCpu
|
||||
<img className="screenshot-full" src="/img/setup/ecs/ecs-4.png" alt="ECS Setup" />
|
||||
4. Add container details that is shown: <br/>
|
||||
Specify your container name ex: `ToolJet` <br/>
|
||||
Set the image you intend to deploy. ex: `tooljet/tooljet:EE-LTS-latest` <br/>
|
||||
Update port mappings at container port `3000` for tcp protocol.
|
||||
<img className="screenshot-full" src="/img/setup/ecs/ecs-5.png" alt="ECS Setup" />
|
||||
|
||||
i. Select Fargate as launch type compatibility
|
||||
|
||||
ii. Configure IAM roles and set operating system family as Linux.
|
||||
|
||||
iii. Select task size to have 3GB of memory and 1vCpu
|
||||
Specify environmental values for the container. You'd want to make use of secrets to store sensitive information or credentials, kindly refer the AWS [docs](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data-secrets.html) to set it up. You can also store the env in S3 bucket, kindly refer the AWS [docs](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/taskdef-envfiles.html) .
|
||||
<img className="screenshot-full" src="/img/setup/ecs/ecs-6.png" alt="ECS Setup" />
|
||||
|
||||
<div style={{textAlign: 'center'}}>
|
||||
:::info
|
||||
For the setup, ToolJet requires:
|
||||
<ul>
|
||||
- **TOOLJET_DB**
|
||||
- **TOOLJET_DB_HOST**
|
||||
- **TOOLJET_DB_USER**
|
||||
- **TOOLJET_DB_PASS**
|
||||
- **PG_HOST**
|
||||
- **PG_DB**
|
||||
- **PG_USER**
|
||||
- **PG_PASS**
|
||||
- **SECRET_KEY_BASE**
|
||||
- **LOCKBOX_KEY**
|
||||
</ul>
|
||||
<br/>
|
||||
Read **[environment variables reference](./env-vars)**
|
||||
:::
|
||||
|
||||
<img className="screenshot-full" src="/img/setup/ecs/ecs-4.png" alt="ECS Setup" />
|
||||
|
||||
</div>
|
||||
|
||||
iv. Add container details that is shown:
|
||||
|
||||
Specify your container name ex: `ToolJet`
|
||||
|
||||
Set the image you intend to deploy. ex: `tooljet/tooljet:EE-LTS-latest`
|
||||
|
||||
Update port mappings at container port `3000` for tcp protocol.
|
||||
|
||||
<div style={{textAlign: 'center'}}>
|
||||
|
||||
<img className="screenshot-full" src="/img/setup/ecs/ecs-5.png" alt="ECS Setup" />
|
||||
|
||||
</div>
|
||||
|
||||
Specify environmental values for the container. You'd want to make use of secrets to store sensitive information or credentials, kindly refer the AWS [docs](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data-secrets.html) to set it up. You can also store the env in S3 bucket, kindly refer the AWS [docs](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/taskdef-envfiles.html) .
|
||||
|
||||
<div style={{textAlign: 'center'}}>
|
||||
|
||||
<img className="screenshot-full" src="/img/setup/ecs/ecs-6.png" alt="ECS Setup" />
|
||||
|
||||
</div>
|
||||
|
||||
:::info
|
||||
For the minimal setup, ToolJet requires: `TOOLJET_HOST`, `PG_HOST`, `PG_DB`, `PG_USER`, `PG_PASSWORD`, `SECRET_KEY_BASE` & `LOCKBOX_MASTER_KEY` keys in the secret.
|
||||
|
||||
Read **[environment variables reference](https://docs.tooljet.com/docs/setup/env-vars)**
|
||||
:::
|
||||
|
||||
Additionally, include the Redis environment variables within the ToolJet container mentioned above if you have followed the previous steps to create Redis.
|
||||
|
||||
```
|
||||
REDIS_HOST=<public ip of redis task>
|
||||
REDIS_PORT=6379
|
||||
REDIS_USER=default
|
||||
REDIS_PASSWORD=
|
||||
```
|
||||
|
||||
v. Make sure `Use log collection checked` and `Docker configuration` with the command `npm run start:dev`
|
||||
|
||||
<div style={{textAlign: 'center'}}>
|
||||
|
||||
<img className="screenshot-full" src="/img/setup/ecs/ecs-8.png" alt="ECS Setup" />
|
||||
|
||||
</div>
|
||||
Additionally, include the Redis environment variables within the ToolJet container mentioned above if you have followed the previous steps to create Redis.
|
||||
```
|
||||
REDIS_HOST=<public ip of redis task>
|
||||
REDIS_PORT=6379
|
||||
REDIS_USER=default
|
||||
REDIS_PASSWORD=
|
||||
```
|
||||
5. Make sure `Use log collection checked` and `Docker configuration` with the command `npm run start:dev`
|
||||
<img className="screenshot-full" src="/img/setup/ecs/ecs-8.png" alt="ECS Setup" />
|
||||
|
||||
4. Create a service to run your task definition within your cluster.
|
||||
|
||||
- Select the cluster which you have created
|
||||
|
||||
- Select launch type as Fargate
|
||||
|
||||
<div style={{textAlign: 'center'}}>
|
||||
|
||||
<img className="screenshot-full" src="/img/setup/ecs/ecs-9.png" alt="ECS Setup" />
|
||||
|
||||
</div>
|
||||
|
||||
<img className="screenshot-full" src="/img/setup/ecs/ecs-9.png" alt="ECS Setup" />
|
||||
- Select the cluster and set the service name
|
||||
|
||||
- You can set the number of tasks to start with as two
|
||||
|
||||
- Rest of the values can be kept as default
|
||||
|
||||
<div style={{textAlign: 'center'}}>
|
||||
|
||||
<img className="screenshot-full" src="/img/setup/ecs/ecs-10.png" alt="ECS Setup" />
|
||||
|
||||
</div>
|
||||
|
||||
<img className="screenshot-full" src="/img/setup/ecs/ecs-10.png" alt="ECS Setup" />
|
||||
- Click on next step to configure networking options
|
||||
|
||||
- Select your designated VPC, Subnets and Security groups. Kindly ensure that the security group allows for inbound traffic to http port 3000 for the task.
|
||||
|
||||
<div style={{textAlign: 'center'}}>
|
||||
|
||||
<img className="screenshot-full" src="/img/setup/ecs/ecs-11.png" alt="ECS Setup" />
|
||||
|
||||
</div>
|
||||
|
||||
<img className="screenshot-full" src="/img/setup/ecs/ecs-11.png" alt="ECS Setup" />
|
||||
- Since migrations are run as a part of container boot, please specify health check grace period for 900 seconds. Select the application loadbalancer option and set the target group name to the one we had created earlier. This will auto populate the health check endpoints.
|
||||
|
||||
:::info
|
||||
The setup above is just a template. Feel free to update the task definition and configure parameters for resources and environment variables according to your needs.
|
||||
:::
|
||||
|
||||
</div>
|
||||
|
||||
<div style={{paddingTop:'24px'}}>
|
||||
|
||||
## ToolJet Database
|
||||
|
||||
If you intend to use this feature, you'd have to set up and deploy PostgREST server which helps querying ToolJet Database. You can learn more about this feature [here](https://docs.tooljet.com/docs/tooljet-database).
|
||||
To use ToolJet Database, you'd have to set up and deploy PostgREST server which helps querying ToolJet Database. You can learn more about this feature [here](../tooljet-db/tooljet-database).
|
||||
|
||||
Deploying ToolJet Database is mandatory from ToolJet 3.0 or else the migration might break, checkout the following docs to know more about new major version, including breaking changes that require you to adjust your applications accordingly:
|
||||
- [Self Hosted](./upgrade-to-v3.md)
|
||||
- [Cloud](./cloud-v3-migration.md)
|
||||
|
||||
Follow the steps below to deploy PostgREST on a ECS cluster.
|
||||
|
||||
|
|
@ -225,7 +180,9 @@ Follow the steps below to deploy PostgREST on a ECS cluster.
|
|||
|
||||
</div>
|
||||
|
||||
Update ToolJet deployment with the appropriate env variables [here](https://docs.tooljet.com/docs/setup/env-vars/#enable-tooljet-database--optional-) and apply the changes.
|
||||
Update ToolJet deployment with the appropriate env variables [here](./env-vars/#enable-tooljet-database-required) and apply the changes.
|
||||
|
||||
</div>
|
||||
|
||||
## Upgrading to the Latest LTS Version
|
||||
|
||||
|
|
@ -239,5 +196,4 @@ If this is a new installation of the application, you may start directly with th
|
|||
|
||||
- Users on versions earlier than **v2.23.0-ee2.10.2** must first upgrade to this version before proceeding to the LTS version.
|
||||
|
||||
For specific issues or questions, refer to our **[Slack](https://tooljet.slack.com/join/shared_invite/zt-25438diev-mJ6LIZpJevG0LXCEcL0NhQ#)**.
|
||||
|
||||
*If you have any questions feel free to join our [Slack Community](https://tooljet.com/slack) or send us an email at hello@tooljet.com.*
|
||||
|
|
|
|||
|
|
@ -92,11 +92,10 @@ Use this environment variable to enable/disable the developement mode that allow
|
|||
| ---------------- | ----------------------------------------------- |
|
||||
| USER_SESSION_EXPIRY | This variable controls the user session expiry time. By default, the session expires after **10** days. The variable expects the value in minutes. ex: USER_SESSION_EXPIRY = 120 which is 2 hours |
|
||||
|
||||
### Enable ToolJet Database ( optional )
|
||||
### Enable ToolJet Database (required)
|
||||
|
||||
| variable | description |
|
||||
| -----------------------------| -------------------------------------------- |
|
||||
| ENABLE_TOOLJET_DB | `true` or `false` |
|
||||
| TOOLJET_DB | Default value is `tooljet_db` |
|
||||
| TOOLJET_DB_HOST | database host |
|
||||
| TOOLJET_DB_USER | database username |
|
||||
|
|
@ -104,8 +103,7 @@ Use this environment variable to enable/disable the developement mode that allow
|
|||
| TOOLJET_DB_PORT | database port |
|
||||
| PGRST_JWT_SECRET | JWT token client provided for authentication |
|
||||
| PGRST_HOST | postgrest database host |
|
||||
| TOOLJET_DB_RECONFIG | `true` or `false` |
|
||||
| TOOLJET_DB_STATEMENT_TIMEOUT | statement timeout in milliseconds |
|
||||
| PGRST_DB_PRE_CONFIG | postgrest.pre_config |
|
||||
|
||||
Use `ENABLE_TOOLJET_DB` to enable/disable the feature that allows users to work with inbuilt data store to build apps with. In order to set it up, [follow the instructions here](/docs/tooljet-db/tooljet-database/#enabling-the-tooljet-database-for-your-instance).
|
||||
|
||||
|
|
@ -296,13 +294,13 @@ This can be an absolute path, or relative to main HTML file.
|
|||
By default the client build will be done to be served with ToolJet server.
|
||||
If you intend to use client separately then can set `SERVE_CLIENT` to `false`.
|
||||
|
||||
## PostgREST server (Optional)
|
||||
## PostgREST server (required)
|
||||
|
||||
| variable | description |
|
||||
| ---------------- | ----------------------------------------------- |
|
||||
| PGRST_JWT_SECRET | JWT token client provided for authentication |
|
||||
| PGRST_DB_URI | database connection string for tooljet database |
|
||||
| PGRST_LOG_LEVEL | `info` |
|
||||
| variable | description |
|
||||
| ------------------ | ----------------------------------------------- |
|
||||
| PGRST_JWT_SECRET | JWT token client provided for authentication |
|
||||
| PGRST_DB_URI | database connection string for tooljet database |
|
||||
| PGRST_LOG_LEVEL | `info` |
|
||||
|
||||
If you intent to make changes in the above configuration. Please refer [PostgREST configuration docs](https://postgrest.org/en/stable/configuration.html#environment-variables).
|
||||
|
||||
|
|
|
|||
|
|
@ -9,11 +9,8 @@ title: Google Cloud Run
|
|||
You should setup a PostgreSQL database manually to be used by ToolJet.
|
||||
:::
|
||||
|
||||
*If you have any questions feel free to join our [Slack Community](https://tooljet.com/slack) or send us an email at hello@tooljet.com.*
|
||||
|
||||
Follow the steps below to deploy ToolJet on Cloud run with `gcloud` CLI.
|
||||
|
||||
|
||||
## Deploying ToolJet application
|
||||
1. Create a new Google Cloud Run Service:
|
||||
|
||||
|
|
@ -72,75 +69,42 @@ Click on deploy once the above parameters are set.
|
|||
Once the Service is created and live, to make the Cloud Service URL public. Please follow the steps [**here**](https://cloud.google.com/run/docs/securing/managing-access) to make the service public.
|
||||
:::
|
||||
|
||||
### Deploying ToolJet Database
|
||||
## Deploying ToolJet Database
|
||||
|
||||
If you intend to use this feature, you'd have to set up and deploy PostgREST server which helps querying ToolJet Database.
|
||||
|
||||
#### PostgREST server
|
||||
To use ToolJet Database, you'd have to set up and deploy PostgREST server which helps querying ToolJet Database. Deploying ToolJet Database is mandatory from ToolJet 3.0 or else the migration might break, checkout the following docs to know more about new major version, including breaking changes that require you to adjust your applications accordingly:
|
||||
- [Self Hosted](./upgrade-to-v3.md)
|
||||
|
||||
1. Cloud Run requires prebuilt image to be present within cloud registry. You can pull specific PostgREST image from docker hub and then tag with your project to push it to cloud registry.
|
||||
```bash
|
||||
docker pull postgrest/postgrest:v12.0.2
|
||||
```
|
||||
|
||||
```bash
|
||||
gcloud auth configure-docker
|
||||
docker pull postgrest/postgrest:v10.1.1.20221215
|
||||
docker tag postgrest/postgrest:v10.1.1.20221215 gcr.io/tooljet-test-338806/postgrest/postgrest:v10.1.1.20221215
|
||||
docker push gcr.io/tooljet-test-338806/postgrest/postgrest:v10.1.1.20221215
|
||||
```
|
||||
Please run the above command by launching googleCLI which will help to push the PostgREST image to Google container registry.
|
||||
|
||||
2. Ingress and Authentication can be set as shown below, to begin with. Feel free to change the security configurations as per you see fit.
|
||||
|
||||
<img className="screenshot-full" src="/img/cloud-run/ingress-auth.png" alt="ingress-auth" />
|
||||
|
||||
|
||||
3. Under containers tab, please make sure the port is set 3000 and CPU capacity is set to 1GiB.
|
||||
|
||||
<img className="screenshot-full" src="/img/cloud-run/port-and-capacity-postgrest.png" alt="port-and-capacity-postgrest" />
|
||||
|
||||
Please run the above command by launching googleCLI which will help to push the PostgREST image to Google container registry.
|
||||
4. Under environmental variable please add corresponding ToolJet database env variables. You can also refer [env variable](./env-vars/#enable-tooljet-database-required).
|
||||
|
||||
<div style={{textAlign: 'center'}}>
|
||||
<img className="screenshot-full" src="/img/cloud-run/CLI.png" alt="CLI" />
|
||||
</div>
|
||||
5. Please go to connection tab. Under Cloud SQL instance please select the PostgreSQL database which you have set-up for ToolJet application or the separate PostgreSQL database created respective to ToolJet Database from the drop-down option.
|
||||
|
||||
<img className="screenshot-full" src="/img/cloud-run/Cloud-SQL-instance.png" alt="Cloud-SQL-instance" />
|
||||
|
||||
2. Once the PostgREST image is pushed. Click on create service.
|
||||
Click on deploy once the above parameters are set.
|
||||
|
||||
Select and add the pushed PostgREST image as shown in below.
|
||||
:::info
|
||||
Once the Service is created and live, to make the Cloud Service URL public. Please follow the steps [**here**](https://cloud.google.com/run/docs/securing/managing-access) to make the service public.
|
||||
:::
|
||||
|
||||
<div style={{textAlign: 'center'}}>
|
||||
<img className="screenshot-full" src="/img/cloud-run/create-service-cloud-run-postgrest.png" alt="create-service-cloud-run-postgrest" />
|
||||
</div>
|
||||
|
||||
|
||||
3. Ingress and Authentication can be set as shown below, to begin with. Feel free to change the security configurations as per you see fit.
|
||||
|
||||
<div style={{textAlign: 'center'}}>
|
||||
<img className="screenshot-full" src="/img/cloud-run/ingress-auth.png" alt="ingress-auth" />
|
||||
</div>
|
||||
|
||||
|
||||
4. Under containers tab, please make sure the port is set 3000 and CPU capacity is set to 1GiB.
|
||||
|
||||
<div style={{textAlign: 'center'}}>
|
||||
<img className="screenshot-full" src="/img/cloud-run/port-and-capacity-postgrest.png" alt="port-and-capacity-postgrest" />
|
||||
</div>
|
||||
|
||||
5. Under environmental variable please add corresponding ToolJet database env variables. You can also refer [env variable](/docs/setup/env-vars/#enable-tooljet-database--optional-).
|
||||
|
||||
6. Please go to connection tab. Under Cloud SQL instance please select the PostgreSQL database which you have set-up for ToolJet application or the separate PostgreSQL database created respective to ToolJet Database from the drop-down option.
|
||||
|
||||
|
||||
<div style={{textAlign: 'center'}}>
|
||||
<img className="screenshot-full" src="/img/cloud-run/Cloud-SQL-instance.png" alt="Cloud-SQL-instance" />
|
||||
</div>
|
||||
|
||||
|
||||
Click on deploy once the above parameters are set.
|
||||
|
||||
:::info
|
||||
Once the Service is created and live, to make the Cloud Service URL public. Please follow the steps [**here**](https://cloud.google.com/run/docs/securing/managing-access) to make the service public.
|
||||
:::
|
||||
|
||||
|
||||
|
||||
7. Additional Environmental variable to be added to ToolJet application or ToolJet Server connect to PostgREST server. You can also refer env variable [**here**](/docs/setup/env-vars/#enable-tooljet-database--optional-)
|
||||
|
||||
|
||||
<div style={{textAlign: 'center'}}>
|
||||
<img className="screenshot-full" src="/img/cloud-run/env-for-tooljet.png" alt="env-for-tooljet" />
|
||||
</div>
|
||||
6. Additional Environmental variable to be added to ToolJet application or ToolJet Server connect to PostgREST server. You can also refer env variable [**here**](./env-vars/#enable-tooljet-database-required)
|
||||
|
||||
<img className="screenshot-full" src="/img/cloud-run/env-for-tooljet.png" alt="env-for-tooljet" />
|
||||
|
||||
## Upgrading to the Latest LTS Version
|
||||
|
||||
|
|
@ -154,4 +118,4 @@ If this is a new installation of the application, you may start directly with th
|
|||
|
||||
- Users on versions earlier than **v2.23.0-ee2.10.2** must first upgrade to this version before proceeding to the LTS version.
|
||||
|
||||
For specific issues or questions, refer to our **[Slack](https://tooljet.slack.com/join/shared_invite/zt-25438diev-mJ6LIZpJevG0LXCEcL0NhQ#)**.
|
||||
*If you have any questions feel free to join our [Slack Community](https://tooljet.com/slack) or send us an email at hello@tooljet.com.*
|
||||
|
|
|
|||
|
|
@ -7,8 +7,6 @@ title: Helm
|
|||
|
||||
This repository contains Helm charts for deploying [ToolJet](https://github.com/ToolJet/helm-charts) on a Kubernetes Cluster using Helm v3. The charts include an integrated PostgreSQL server that is enabled by default. However, you have the option to disable it and configure a different PostgreSQL server by updating the `values.yml` file.
|
||||
|
||||
*If you have any questions feel free to join our [Slack Community](https://tooljet.com/slack) or send us an email at hello@tooljet.com.*
|
||||
|
||||
## Installation
|
||||
|
||||
### From Helm repo
|
||||
|
|
@ -17,23 +15,21 @@ helm repo add tooljet https://github.com/ToolJet/helm-charts.git
|
|||
helm install tooljet tooljet/tooljet
|
||||
```
|
||||
|
||||
### From the source
|
||||
### From the Source
|
||||
1. Clone the repository and navigate to this directory
|
||||
2. Run `helm dependency update
|
||||
2. Run `helm dependency update`
|
||||
3. It is recommended but optional to modify the values in the `values.yaml` file, such as usernames, passwords, persistence settings, etc.
|
||||
4. Run `helm install -n $NAMESPACE --create-namespace $RELEASE .`
|
||||
|
||||
Remember to replace the variables with your specific configuration values.
|
||||
|
||||
**ToolJet Database**
|
||||
## ToolJet Database
|
||||
|
||||
ToolJet offers a hosted database solution that allows you to build applications quickly and manage your data effortlessly. The ToolJet database requires no setup and provides a user-friendly interface for data management.
|
||||
|
||||
For more information about the ToolJet database, you can visit [here](/docs/tooljet-database).
|
||||
For more information about the ToolJet database, you can visit [here](../tooljet-db/tooljet-database).
|
||||
|
||||
If you plan to use this feature, you need to set up and deploy the PostgREST server, which facilitates querying the ToolJet Database.
|
||||
|
||||
To enable the ToolJet database, please set the environment variable `ENABLE_TOOLJET_DB` to true in the `values.yaml` file.
|
||||
You need to set up and deploy the PostgREST server, which facilitates querying the ToolJet Database.
|
||||
|
||||
## Upgrading to the Latest LTS Version
|
||||
|
||||
|
|
@ -47,4 +43,4 @@ If this is a new installation of the application, you may start directly with th
|
|||
|
||||
- Users on versions earlier than **v2.23.0-ee2.10.2** must first upgrade to this version before proceeding to the LTS version.
|
||||
|
||||
For specific issues or questions, refer to our **[Slack](https://tooljet.slack.com/join/shared_invite/zt-25438diev-mJ6LIZpJevG0LXCEcL0NhQ#)**.
|
||||
*If you have any questions feel free to join our [Slack Community](https://tooljet.com/slack) or send us an email at hello@tooljet.com.*
|
||||
|
|
|
|||
|
|
@ -9,8 +9,6 @@ title: Kubernetes (AKS)
|
|||
You should setup a PostgreSQL database manually to be used by ToolJet. We recommend using Azure Database for PostgreSQL since this guide is for deploying using AKS.
|
||||
:::
|
||||
|
||||
*If you have any questions feel free to join our [Slack Community](https://tooljet.com/slack) or send us an email at hello@tooljet.com.*
|
||||
|
||||
Follow the steps below to deploy ToolJet on a AKS Kubernetes cluster.
|
||||
|
||||
1. Create an AKS cluster and connect to it to start with the deployment. You can follow the steps as mentioned on the [Azure's documentation](https://docs.microsoft.com/en-us/azure/aks/kubernetes-walkthrough-portal).
|
||||
|
|
@ -21,7 +19,25 @@ Follow the steps below to deploy ToolJet on a AKS Kubernetes cluster.
|
|||
curl -LO https://tooljet-deployments.s3.us-west-1.amazonaws.com/kubernetes/AKS/deployment.yaml
|
||||
```
|
||||
|
||||
Make sure to edit the environment variables in the `deployment.yaml`. We advise to use secrets to setup sensitive information. You can check out the available options [here](https://docs.tooljet.com/docs/setup/env-vars).
|
||||
Make sure to edit the environment variables in the `deployment.yaml`. We advise to use secrets to setup sensitive information. You can check out the available options [here](./env-vars).
|
||||
|
||||
:::info
|
||||
For the setup, ToolJet requires:
|
||||
<ul>
|
||||
- **TOOLJET_DB**
|
||||
- **TOOLJET_DB_HOST**
|
||||
- **TOOLJET_DB_USER**
|
||||
- **TOOLJET_DB_PASS**
|
||||
- **PG_HOST**
|
||||
- **PG_DB**
|
||||
- **PG_USER**
|
||||
- **PG_PASS**
|
||||
- **SECRET_KEY_BASE**
|
||||
- **LOCKBOX_KEY**
|
||||
</ul>
|
||||
<br/>
|
||||
Read **[environment variables reference](./env-vars)**
|
||||
:::
|
||||
|
||||
:::info
|
||||
If there are self signed HTTPS endpoints that Tooljet needs to connect to, please make sure that `NODE_EXTRA_CA_CERTS` environment variable is set to the absolute path containing the certificates. You can make use of kubernetes secrets to mount the certificate file onto the containers.
|
||||
|
|
@ -40,11 +56,9 @@ If there are self signed HTTPS endpoints that Tooljet needs to connect to, pleas
|
|||
|
||||
You will be able to access your ToolJet installation once the pods and services running.
|
||||
|
||||
|
||||
|
||||
## ToolJet Database
|
||||
|
||||
If you intend to use this feature, you'd have to set up and deploy PostgREST server which helps querying ToolJet Database. Please [follow the instructions here](/docs/setup/env-vars/#enable-tooljet-database--optional-) for additional environment variables configuration to be done.
|
||||
To use ToolJet Database, you'd have to set up and deploy PostgREST server which helps querying ToolJet Database. Please [follow the instructions here](./env-vars/#enable-tooljet-database-required).
|
||||
|
||||
1. Setup PostgREST server
|
||||
|
||||
|
|
@ -66,4 +80,4 @@ If this is a new installation of the application, you may start directly with th
|
|||
|
||||
- Users on versions earlier than **v2.23.0-ee2.10.2** must first upgrade to this version before proceeding to the LTS version.
|
||||
|
||||
For specific issues or questions, refer to our **[Slack](https://tooljet.slack.com/join/shared_invite/zt-25438diev-mJ6LIZpJevG0LXCEcL0NhQ#)**.
|
||||
*If you have any questions feel free to join our [Slack Community](https://tooljet.com/slack) or send us an email at hello@tooljet.com.*
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ title: Kubernetes (EKS)
|
|||
Follow the steps below to deploy ToolJet on an EKS Kubernetes cluster.
|
||||
|
||||
:::info
|
||||
You should set up a PostgreSQL database manually to be used by ToolJet. We recommend using an RDS PostgreSQL database. You can find the system requirements [here](https://docs.tooljet.com/docs/setup/system-requirements#database-software)
|
||||
You should set up a PostgreSQL database manually to be used by ToolJet. We recommend using an RDS PostgreSQL database. You can find the system requirements [here](./system-requirements#database-software)
|
||||
:::
|
||||
|
||||
1. Create an EKS cluster and connect to it to start with the deployment. You can follow the steps as mentioned in the [AWS documentation](https://docs.aws.amazon.com/eks/latest/userguide/create-cluster.html).
|
||||
|
|
@ -19,7 +19,25 @@ _The file below is just a template and might not suit production environments. Y
|
|||
kubectl apply -f https://tooljet-deployments.s3.us-west-1.amazonaws.com/kubernetes/deployment.yaml
|
||||
```
|
||||
|
||||
Make sure to edit the environment variables in the `deployment.yaml`. We advise using secrets to set up sensitive information. You can check out the available options [here](https://docs.tooljet.com/docs/setup/env-vars).
|
||||
Make sure to edit the environment variables in the `deployment.yaml`. We advise using secrets to set up sensitive information. You can check out the available options [here](./env-vars).
|
||||
|
||||
:::info
|
||||
For the setup, ToolJet requires:
|
||||
<ul>
|
||||
- **TOOLJET_DB**
|
||||
- **TOOLJET_DB_HOST**
|
||||
- **TOOLJET_DB_USER**
|
||||
- **TOOLJET_DB_PASS**
|
||||
- **PG_HOST**
|
||||
- **PG_DB**
|
||||
- **PG_USER**
|
||||
- **PG_PASS**
|
||||
- **SECRET_KEY_BASE**
|
||||
- **LOCKBOX_KEY**
|
||||
</ul>
|
||||
<br/>
|
||||
Read **[environment variables reference](./env-vars)**
|
||||
:::
|
||||
|
||||
3. Create a Kubernetes service to publish the Kubernetes deployment that you have created. We have a [template](https://tooljet-deployments.s3.us-west-1.amazonaws.com/kubernetes/service.yaml) for exposing the ToolJet server as a service using an AWS Load Balancer.
|
||||
|
||||
|
|
@ -28,7 +46,7 @@ Make sure to edit the environment variables in the `deployment.yaml`. We advise
|
|||
|
||||
## ToolJet Database
|
||||
|
||||
If you intend to use this feature, you'd have to set up and deploy a PostgREST server, which helps in querying the ToolJet Database. Please [follow the instructions here](https://docs.tooljet.com/docs/setup/env-vars/#enable-tooljet-database--optional-) for additional environment variables configuration.
|
||||
To use ToolJet Database, you'd have to set up and deploy a PostgREST server, which helps in querying the ToolJet Database. Please [follow the instructions here](./env-vars/#enable-tooljet-database-required).
|
||||
|
||||
1. Set up PostgREST server
|
||||
|
||||
|
|
@ -50,4 +68,4 @@ If this is a new installation of the application, you may start directly with th
|
|||
|
||||
- Users on versions earlier than **v2.23.0-ee2.10.2** must first upgrade to this version before proceeding to the LTS version.
|
||||
|
||||
For specific issues or questions, refer to our **[Slack](https://tooljet.slack.com/join/shared_invite/zt-25438diev-mJ6LIZpJevG0LXCEcL0NhQ#)**.
|
||||
*If you have any questions feel free to join our [Slack Community](https://tooljet.com/slack) or send us an email at hello@tooljet.com.*
|
||||
|
|
|
|||
|
|
@ -9,8 +9,6 @@ title: Kubernetes (GKE)
|
|||
You should setup a PostgreSQL database manually to be used by ToolJet. We recommend using Cloud SQL since this guide is for deploying using GKE.
|
||||
:::
|
||||
|
||||
*If you have any questions feel free to join our [Slack Community](https://tooljet.com/slack) or send us an email at hello@tooljet.com.*
|
||||
|
||||
Follow the steps below to deploy ToolJet on a GKE Kubernetes cluster.
|
||||
|
||||
1. Create an SSL certificate.
|
||||
|
|
@ -33,7 +31,24 @@ gcloud compute addresses create tj-static-ip --global
|
|||
curl -LO https://tooljet-deployments.s3.us-west-1.amazonaws.com/kubernetes/GKE/deployment.yaml
|
||||
```
|
||||
|
||||
Make sure to edit the environment variables in the `deployment.yaml`. You can check out the available options [here](https://docs.tooljet.com/docs/setup/env-vars).
|
||||
Make sure to edit the environment variables in the `deployment.yaml`. You can check out the available options [here](./env-vars).
|
||||
|
||||
:::info
|
||||
For the setup, ToolJet requires:
|
||||
<ul>
|
||||
- **TOOLJET_DB**
|
||||
- **TOOLJET_DB_HOST**
|
||||
- **TOOLJET_DB_USER**
|
||||
- **TOOLJET_DB_PASS**
|
||||
- **PG_HOST**
|
||||
- **PG_DB**
|
||||
- **PG_USER**
|
||||
- **PG_PASS**
|
||||
- **SECRET_KEY_BASE**
|
||||
- **LOCKBOX_KEY**
|
||||
</ul>
|
||||
Read **[environment variables reference](./env-vars)**
|
||||
:::
|
||||
|
||||
:::info
|
||||
If there are self signed HTTPS endpoints that Tooljet needs to connect to, please make sure that `NODE_EXTRA_CA_CERTS` environment variable is set to the absolute path containing the certificates. You can make use of kubernetes secrets to mount the certificate file onto the containers.
|
||||
|
|
@ -65,12 +80,9 @@ It might take a few minutes to provision the managed certificates. [Managed cert
|
|||
|
||||
You will be able to access your ToolJet installation once the pods, service and the ingress is running.
|
||||
|
||||
|
||||
|
||||
|
||||
## ToolJet Database
|
||||
|
||||
If you intend to use this feature, you'd have to set up and deploy PostgREST server which helps querying ToolJet Database. Please [follow the instructions here](/docs/setup/env-vars/#enable-tooljet-database--optional-) for additional environment variables configuration to be done.
|
||||
To use ToolJet Database, you'd have to set up and deploy PostgREST server which helps querying ToolJet Database. Please [follow the instructions here](./env-vars/#enable-tooljet-database-required).
|
||||
|
||||
1. Setup PostgREST server
|
||||
|
||||
|
|
@ -92,4 +104,4 @@ If this is a new installation of the application, you may start directly with th
|
|||
|
||||
- Users on versions earlier than **v2.23.0-ee2.10.2** must first upgrade to this version before proceeding to the LTS version.
|
||||
|
||||
For specific issues or questions, refer to our **[Slack](https://tooljet.slack.com/join/shared_invite/zt-25438diev-mJ6LIZpJevG0LXCEcL0NhQ#)**.
|
||||
*If you have any questions feel free to join our [Slack Community](https://tooljet.com/slack) or send us an email at hello@tooljet.com.*
|
||||
|
|
|
|||
|
|
@ -9,17 +9,25 @@ title: Kubernetes
|
|||
You should setup a PostgreSQL database manually to be used by ToolJet.
|
||||
:::
|
||||
|
||||
*If you have any questions feel free to join our [Slack Community](https://tooljet.com/slack) or send us an email at hello@tooljet.com.*
|
||||
|
||||
Follow the steps below to deploy ToolJet on a Kubernetes cluster.
|
||||
|
||||
1. Setup a PostgreSQL database
|
||||
1. **Setup a PostgreSQL database** <br/>
|
||||
ToolJet uses a postgres database as the persistent storage for storing data related to users and apps. We do not have plans to support other databases such as MySQL.
|
||||
2. **Create a Kubernetes secret with name `server`.** <br/>
|
||||
For the setup, ToolJet requires:
|
||||
|
||||
- **TOOLJET_DB**
|
||||
- **TOOLJET_DB_HOST**
|
||||
- **TOOLJET_DB_USER**
|
||||
- **TOOLJET_DB_PASS**
|
||||
- **PG_HOST**
|
||||
- **PG_DB**
|
||||
- **PG_USER**
|
||||
- **PG_PASS**
|
||||
- **SECRET_KEY_BASE**
|
||||
- **LOCKBOX_KEY**
|
||||
|
||||
2. Create a Kubernetes secret with name `server`. For the minimal setup, ToolJet requires `pg_host`, `pg_db`, `pg_user`, `pg_password`, `secret_key_base` & `lockbox_key` keys in the secret.
|
||||
|
||||
Read **[environment variables reference](/docs/setup/env-vars)**
|
||||
|
||||
Read **[environment variables reference](./env-vars)**
|
||||
3. Create a Kubernetes deployment
|
||||
|
||||
```bash
|
||||
|
|
@ -48,21 +56,9 @@ If there are self signed HTTPS endpoints that ToolJet needs to connect to, pleas
|
|||
- [GKE Ingress for HTTP(S) Load Balancing](https://cloud.google.com/kubernetes-engine/docs/concepts/ingress)
|
||||
|
||||
:::tip
|
||||
If you want to serve ToolJet client from services such as Firebase or Netlify, please read the client Setup documentation **[here](/docs/setup/client)**.
|
||||
If you want to serve ToolJet client from services such as Firebase or Netlify, please read the client Setup documentation **[here](./client)**.
|
||||
:::
|
||||
|
||||
## ToolJet Database
|
||||
|
||||
If you intend to use this feature, you'd have to set up and deploy PostgREST server which helps querying ToolJet Database. Please [follow the instructions here](/docs/setup/env-vars/#enable-tooljet-database--optional-) for additional environment variables configuration to be done.
|
||||
|
||||
1. Setup PostgREST server
|
||||
|
||||
```bash
|
||||
kubectl apply -f https://raw.githubusercontent.com/ToolJet/ToolJet/main/deploy/kubernetes/postgrest.yaml
|
||||
```
|
||||
|
||||
2. Update ToolJet deployment with the appropriate env variables [here](https://tooljet-deployments.s3.us-west-1.amazonaws.com/kubernetes/deployment.yaml) and apply the changes.
|
||||
|
||||
## Upgrading to the Latest LTS Version
|
||||
|
||||
New LTS versions are released every 3-5 months with an end-of-life of atleast 18 months. To check the latest LTS version, visit the [ToolJet Docker Hub](https://hub.docker.com/r/tooljet/tooljet/tags) page. The LTS tags follow a naming convention with the prefix `LTS-` followed by the version number, for example `tooljet/tooljet:EE-LTS-latest`.
|
||||
|
|
@ -75,4 +71,4 @@ If this is a new installation of the application, you may start directly with th
|
|||
|
||||
- Users on versions earlier than **v2.23.0-ee2.10.2** must first upgrade to this version before proceeding to the LTS version.
|
||||
|
||||
For specific issues or questions, refer to our **[Slack](https://tooljet.slack.com/join/shared_invite/zt-25438diev-mJ6LIZpJevG0LXCEcL0NhQ#)**.
|
||||
*If you have any questions feel free to join our [Slack Community](https://tooljet.com/slack) or send us an email at hello@tooljet.com.*
|
||||
|
|
|
|||
|
|
@ -9,15 +9,23 @@ title: Openshift
|
|||
You should setup a PostgreSQL database manually to be used by ToolJet.
|
||||
:::
|
||||
|
||||
*If you have any questions feel free to join our [Slack Community](https://tooljet.com/slack) or send us an email at hello@tooljet.com.*
|
||||
|
||||
Follow the steps below to deploy ToolJet on Openshift.
|
||||
|
||||
1. Setup a PostgreSQL database ToolJet uses a postgres database as the persistent storage for storing data related to users and apps. We do not have plans to support other databases such as MySQL.
|
||||
|
||||
2. Create a Kubernetes secret with name `server`. For the minimal setup, ToolJet requires `pg_host`, `pg_db`, `pg_user`, `pg_password`, `secret_key_base` & `lockbox_key` keys in the secret.
|
||||
2. Create a Kubernetes secret with name `server`. For the setup, ToolJet requires:
|
||||
- **TOOLJET_DB**
|
||||
- **TOOLJET_DB_HOST**
|
||||
- **TOOLJET_DB_USER**
|
||||
- **TOOLJET_DB_PASS**
|
||||
- **PG_HOST**
|
||||
- **PG_DB**
|
||||
- **PG_USER**
|
||||
- **PG_PASS**
|
||||
- **SECRET_KEY_BASE**
|
||||
- **LOCKBOX_KEY**
|
||||
|
||||
Read **[environment variables reference](https://docs.tooljet.com/docs/setup/env-vars)**
|
||||
Read **[environment variables reference](./env-vars)**
|
||||
|
||||
3. Once you have logged into the Openshift developer dashboard click on `+Add` tab. Select import YAML from the local machine.
|
||||
|
||||
|
|
@ -45,7 +53,7 @@ curl -LO https://tooljet-deployments.s3.us-west-1.amazonaws.com/openshift/servic
|
|||
|
||||
Once you have added the files click on create.
|
||||
|
||||
:info
|
||||
:::info
|
||||
If there are self signed HTTPS endpoints that Tooljet needs to connect to, please make sure that `NODE_EXTRA_CA_CERTS` environment variable is set to the absolute path containing the certificates. You can make use of kubernetes secrets to mount the certificate file onto the containers.
|
||||
:::
|
||||
|
||||
|
|
@ -60,9 +68,9 @@ If there are self signed HTTPS endpoints that Tooljet needs to connect to, pleas
|
|||
|
||||
## ToolJet Database
|
||||
|
||||
You can know more about tooljet database [here](https://docs.tooljet.com/docs/tooljet-database)
|
||||
You can know more about tooljet database [here](../tooljet-db/tooljet-database)
|
||||
|
||||
If you intend to use this feature, you'd have to set up and deploy PostgREST server which helps querying ToolJet Database. Please [follow the instructions here](https://docs.tooljet.com/docs/setup/env-vars/#enable-tooljet-database--optional-) for additional environment variables configuration to be done.
|
||||
To use ToolJet Database, you'd have to set up and deploy PostgREST server which helps querying ToolJet Database. Please [follow the instructions here](./env-vars/#enable-tooljet-database-required).
|
||||
|
||||
```
|
||||
https://tooljet-deployments.s3.us-west-1.amazonaws.com/openshift/postgrest.yaml
|
||||
|
|
@ -80,4 +88,4 @@ If this is a new installation of the application, you may start directly with th
|
|||
|
||||
- Users on versions earlier than **v2.23.0-ee2.10.2** must first upgrade to this version before proceeding to the LTS version.
|
||||
|
||||
For specific issues or questions, refer to our **[Slack](https://tooljet.slack.com/join/shared_invite/zt-25438diev-mJ6LIZpJevG0LXCEcL0NhQ#)**.
|
||||
*If you have any questions feel free to join our [Slack Community](https://tooljet.com/slack) or send us an email at hello@tooljet.com.*
|
||||
|
|
|
|||
|
|
@ -5,8 +5,6 @@ title: Deploying ToolJet on a subpath
|
|||
|
||||
ToolJet can now be deployed at a subpath rather than the root (`/`) of a public domain. Example subpath installation URL: **`http://www.yourcompany.com/apps/tooljet`**
|
||||
|
||||
*If you have any questions feel free to join our [Slack Community](https://tooljet.com/slack) or send us an email at hello@tooljet.com.*
|
||||
|
||||
You'll need to setup the following environment variables if ToolJet installation is on a domain subpath:
|
||||
|
||||
| variable | value |
|
||||
|
|
@ -16,7 +14,7 @@ You'll need to setup the following environment variables if ToolJet installation
|
|||
|
||||
|
||||
:::info
|
||||
See all **[Environment Variables](/docs/setup/env-vars)** here.
|
||||
See all **[Environment Variables](./env-vars)** here.
|
||||
:::
|
||||
|
||||
## Upgrading to the Latest Version
|
||||
|
|
@ -33,6 +31,4 @@ If this is a new installation of the application, you may start directly with th
|
|||
|
||||
- Users on versions earlier than v2.23.0-ee2.10.2 must first upgrade to this version before proceeding to the latest version.
|
||||
|
||||
For specific issues or questions, refer to our **[Slack](https://tooljet.slack.com/join/shared_invite/zt-25438diev-mJ6LIZpJevG0LXCEcL0NhQ#)**.
|
||||
|
||||
|
||||
*If you have any questions feel free to join our [Slack Community](https://tooljet.com/slack) or send us an email at hello@tooljet.com.*
|
||||
|
|
|
|||
|
|
@ -18,14 +18,12 @@ docker run \
|
|||
-v tooljet_data:/var/lib/postgresql/13/main \
|
||||
tooljet/try:latest
|
||||
```
|
||||
*If you have any questions feel free to join our [Slack Community](https://tooljet.com/slack) or send us an email at hello@tooljet.com.*
|
||||
|
||||
|
||||
#### Setup information
|
||||
|
||||
- Runs the ToolJet server on the port 80 on your machine.
|
||||
- Container has postgres already configured within. All the data will be available in the docker volume `tooljet_data`.
|
||||
- You can make use of `--env` or `--env-file` flag to test against various env configurables mentioned [here](https://docs.tooljet.com/docs/setup/env-vars).
|
||||
- You can make use of `--env` or `--env-file` flag to test against various env configurables mentioned [here](./env-vars).
|
||||
- Use `docker stop tooljet` to stop the container and `docker start tooljet` to start the container thereafter.
|
||||
|
||||
#### Dynamic Port Setup
|
||||
|
|
@ -46,3 +44,5 @@ docker run \
|
|||
- The `-e PORT=8080` flag sets the `PORT` environment variable to 8080, allowing the ToolJet server to listen on port 8080.
|
||||
|
||||
By following these instructions, you can easily run the ToolJet server on the port of your choice, ensuring flexibility in your setup.
|
||||
|
||||
*If you have any questions feel free to join our [Slack Community](https://tooljet.com/slack) or send us an email at hello@tooljet.com.*
|
||||
|
|
|
|||
|
|
@ -20,16 +20,14 @@ ToolJet will be releasing new LTS versions every 3-5 months with an end-of-life
|
|||
|
||||
The upgrade process depends on your deployment method. You can follow the upgrade process under the respective setup guides:
|
||||
|
||||
- [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 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)
|
||||
- [Upgrade ToolJet on Kubernetes](/docs/setup/kubernetes#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on Kubernetes(GKE)](/docs/setup/kubernetes-gke#upgrading-to-the-latest-lts-version)
|
||||
- [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)
|
||||
|
||||
|
||||
- [Upgrade ToolJet on DigitalOcean](./digitalocean#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on Docker](./docker#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on AWS EC2](./ec2#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on AWS ECS](./ecs#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on OpenShift](./openshift#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on Helm](./helm#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on Kubernetes](./kubernetes#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on Kubernetes(GKE)](./kubernetes-gke#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on Kubernetes(AKS)](./kubernetes-aks#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on Azure Container Apps](./azure-container#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on Google Cloud Run](./google-cloud-run#upgrading-to-the-latest-lts-version)
|
||||
|
|
|
|||
|
|
@ -24,7 +24,7 @@ Before attempting to upgrade to the ToolJet 3.0:
|
|||
To upgrade, update your Docker image to:
|
||||
|
||||
```bash
|
||||
tooljet/tooljet:v3.0.0-ee-beta.1
|
||||
tooljet/tooljet:v3.0.0-ee-lts
|
||||
```
|
||||
:::warning
|
||||
This is a beta release. Test thoroughly in a non-production environment first.
|
||||
|
|
@ -222,7 +222,9 @@ The `metadata` object will contain detailed information about the request and re
|
|||
|
||||
### ToolJet Database
|
||||
|
||||
ToolJet Database is now a core requirement for the ToolJet 3.0. The ToolJet Database will be automatically enabled and configured by default.
|
||||
ToolJet Database is now a core requirement for the ToolJet 3.0.
|
||||
To use ToolJet Database, you'd have to set up and deploy PostgREST server which helps querying ToolJet Database. Please [follow the instructions here](./env-vars/#enable-tooljet-database-required).
|
||||
|
||||
|
||||
## Help and Support
|
||||
|
||||
|
|
|
|||
|
|
@ -8,12 +8,11 @@ ToolJet version 2 comes with a bunch of exciting features, with the major ones b
|
|||
1. Multi page
|
||||
2. Multi env
|
||||
3. Forms widget
|
||||
4. [Database](/docs/tooljet-database) (Requires opt-in)
|
||||
5. [Marketplace](/docs/marketplace) (Requires opt-in)
|
||||
4. [Database](../tooljet-db/tooljet-database) (Requires opt-in)
|
||||
5. [Marketplace](../marketplace/marketplace-overview) (Requires opt-in)
|
||||
|
||||
Checkout the latest changelog for v2 [here](https://github.com/ToolJet/ToolJet/releases).
|
||||
|
||||
*If you have any questions feel free to join our [Slack Community](https://tooljet.com/slack) or send us an email at hello@tooljet.com.*
|
||||
## Deployment
|
||||
|
||||
Based on your opted deployment method from our [setup doc](/docs/setup/), you can directly deploy v2 without any additional configuration for the default setup.
|
||||
|
|
|
|||
|
|
@ -36,8 +36,7 @@ If this parameter is not specified, then PostgREST refuses authentication reques
|
|||
| PGRST_JWT_SECRET | JWT token client provided for authentication |
|
||||
| PGRST_DB_URI | database connection string for tooljet database |
|
||||
| PGRST_LOG_LEVEL | `info` |
|
||||
| TOOLJET_DB_RECONFIG | `true` or `false` |
|
||||
| TOOLJET_DB_STATEMENT_TIMEOUT | statement timeout in milliseconds |
|
||||
| PGRST_DB_PRE_CONFIG | postgrest.pre_config |
|
||||
|
||||
:::info
|
||||
Please make sure that DB_URI is given in the format `postgres://[USERNAME]:[PASSWORD]@[HOST]:[PORT]/[DATABASE]`
|
||||
|
|
@ -50,7 +49,6 @@ Please make sure that DB_URI is given in the format `postgres://[USERNAME]:[PASS
|
|||
|
||||
| <div style={{ width:"100px"}}> Variable </div> | <div style={{ width:"100px"}}> Description </div> |
|
||||
| ------------------ | -------------------------------------------- |
|
||||
| ENABLE_TOOLJET_DB | `true` or `false` |
|
||||
| TOOLJET_DB | Default value is `tooljet_db` |
|
||||
| TOOLJET_DB_HOST | database host |
|
||||
| TOOLJET_DB_USER | database username |
|
||||
|
|
|
|||
BIN
docs/static/img/cloud-run/env-for-tooljet.png
vendored
BIN
docs/static/img/cloud-run/env-for-tooljet.png
vendored
Binary file not shown.
|
Before Width: | Height: | Size: 82 KiB After Width: | Height: | Size: 55 KiB |
BIN
docs/static/img/setup/ecs/ecs-1.png
vendored
BIN
docs/static/img/setup/ecs/ecs-1.png
vendored
Binary file not shown.
|
Before Width: | Height: | Size: 252 KiB After Width: | Height: | Size: 184 KiB |
BIN
docs/static/img/setup/ecs/ecs-2.png
vendored
BIN
docs/static/img/setup/ecs/ecs-2.png
vendored
Binary file not shown.
|
Before Width: | Height: | Size: 275 KiB After Width: | Height: | Size: 207 KiB |
BIN
docs/static/img/setup/ecs/ecs-3.png
vendored
BIN
docs/static/img/setup/ecs/ecs-3.png
vendored
Binary file not shown.
|
Before Width: | Height: | Size: 231 KiB After Width: | Height: | Size: 177 KiB |
BIN
docs/static/img/setup/ecs/ecs-4.png
vendored
BIN
docs/static/img/setup/ecs/ecs-4.png
vendored
Binary file not shown.
|
Before Width: | Height: | Size: 272 KiB After Width: | Height: | Size: 213 KiB |
BIN
docs/static/img/setup/ecs/ecs-5.png
vendored
BIN
docs/static/img/setup/ecs/ecs-5.png
vendored
Binary file not shown.
|
Before Width: | Height: | Size: 265 KiB After Width: | Height: | Size: 210 KiB |
BIN
docs/static/img/setup/ecs/ecs-8.png
vendored
BIN
docs/static/img/setup/ecs/ecs-8.png
vendored
Binary file not shown.
|
Before Width: | Height: | Size: 272 KiB After Width: | Height: | Size: 206 KiB |
|
|
@ -9,8 +9,6 @@ title: Azure container apps
|
|||
Please note that you need to set up a PostgreSQL database manually to be used by ToolJet. Additionally, you must set up a Redis service through Azure Cache for Redis.
|
||||
:::
|
||||
|
||||
*If you have any questions feel free to join our [Slack Community](https://tooljet.com/slack) or send us an email at hello@tooljet.com.*
|
||||
|
||||
## Deploying ToolJet application
|
||||
|
||||
1. Open the Azure dashboard at https://portal.azure.com, navigate to Container Apps, and click on "Create container app".
|
||||
|
|
@ -35,9 +33,19 @@ Please note that you need to set up a PostgreSQL database manually to be used by
|
|||
</div>
|
||||
|
||||
- Make sure to provide the image tag, and then enter `server/entrypoint.sh, npm, run, start:prod` in the "Command override" field.
|
||||
- Add the following ToolJet application variables under the "Environmental variable" section. You can refer to this [**documentation**](/docs/setup/env-vars) for more information on environment variables.
|
||||
- Add the following ToolJet application variables under the "Environmental variable" section. You can refer to this [**documentation**](./env-vars) for more information on environment variables.
|
||||
|
||||
**Note: For the minimal setup, ToolJet requires: `TOOLJET_HOST`, `PG_HOST`, `PG_DB`, `PG_USER`, `PG_PASSWORD`, `SECRET_KEY_BASE` & `LOCKBOX_MASTER_KEY` keys in the secret.**
|
||||
**Note**: ToolJet requires:
|
||||
- **TOOLJET_DB**
|
||||
- **TOOLJET_DB_HOST**
|
||||
- **TOOLJET_DB_USER**
|
||||
- **TOOLJET_DB_PASS**
|
||||
- **PG_HOST**
|
||||
- **PG_DB**
|
||||
- **PG_USER**
|
||||
- **PG_PASS**
|
||||
- **SECRET_KEY_BASE**
|
||||
- **LOCKBOX_KEY**
|
||||
|
||||
<div style={{textAlign: 'center'}}>
|
||||
|
||||
|
|
@ -119,5 +127,4 @@ If this is a new installation of the application, you may start directly with th
|
|||
|
||||
- Users on versions earlier than **v2.23.0-ee2.10.2** must first upgrade to this version before proceeding to the LTS version.
|
||||
|
||||
For specific issues or questions, refer to our **[Slack](https://tooljet.slack.com/join/shared_invite/zt-25438diev-mJ6LIZpJevG0LXCEcL0NhQ#)**.
|
||||
|
||||
*If you have any questions feel free to join our [Slack Community](https://tooljet.com/slack) or send us an email at hello@tooljet.com.*
|
||||
|
|
|
|||
|
|
@ -90,7 +90,7 @@ ToolJet server and client can be deployed as standalone applications. If you do
|
|||
## Deploying ToolJet Database
|
||||
|
||||
If you intend to use this feature, you'd have to set up and deploy PostgREST server which helps querying ToolJet Database.
|
||||
You can learn more about this feature [here](/docs/tooljet-database).
|
||||
You can learn more about this feature [here](../tooljet-db/tooljet-database).
|
||||
|
||||
Follow the steps below to deploy ToolJet Database on DigitalOcean:
|
||||
|
||||
|
|
|
|||
|
|
@ -9,8 +9,6 @@ title: AWS EC2
|
|||
You should setup a PostgreSQL database manually to be used by the ToolJet server.
|
||||
:::
|
||||
|
||||
*If you have any questions feel free to join our [Slack Community](https://tooljet.com/slack) or send us an email at hello@tooljet.com.*
|
||||
|
||||
You can effortlessly deploy Amazon Elastic Compute Cloud Service (EC2) by utilizing a **CloudFormation template**. This template will deploy all the services required to run ToolJet on AWS EC2 instances.
|
||||
|
||||
To deploy all the services at once, simply employ the following template:
|
||||
|
|
@ -21,15 +19,10 @@ curl -LO https://tooljet-deployments.s3.us-west-1.amazonaws.com/cloudformation/E
|
|||
Follow the steps below to deploy ToolJet on AWS EC2 instances.
|
||||
|
||||
1. Setup a PostgreSQL database and make sure that the database is accessible from the EC2 instance.
|
||||
|
||||
2. Login to your AWS management console and go to the EC2 management page.
|
||||
|
||||
3. Under the `Images` section, click on the `AMIs` button.
|
||||
|
||||
3. Under the **Images** section, click on the **AMIs** button.
|
||||
4. Find the [ToolJet version](https://github.com/ToolJet/ToolJet/releases) you want to deploy. Now, from the AMI search page, select the search type as "Public Images" and input the version you'd want `AMI Name : tooljet_EE-LTS-x.xx.ubuntu_focal` in the search bar.
|
||||
|
||||
5. Select ToolJet's AMI and bootup an EC2 instance.
|
||||
|
||||
5. Select ToolJet's AMI and bootup an EC2 instance. <br/>
|
||||
Creating a new security group is recommended. For example, if the installation should receive traffic from the internet, the inbound rules of the security group should look like this:
|
||||
|
||||
protocol| port | allowed_cidr|
|
||||
|
|
@ -39,19 +32,22 @@ Follow the steps below to deploy ToolJet on AWS EC2 instances.
|
|||
tcp | 443 | 0.0.0.0/0 |
|
||||
|
||||
|
||||
6. Once the instance boots up, SSH into the instance by running `ssh -i <path_to_pem_file> ubuntu@<public_ip_of_the_instance>`
|
||||
6. Once the instance boots up, SSH into the instance by running `ssh -i <path_to_pem_file> ubuntu@<public_ip_of_the_instance>`.
|
||||
|
||||
7. Switch to the app directory by running `cd ~/app`. Modify the contents of the `.env` file. ( Eg: `vim .env` )
|
||||
7. Switch to the app directory by running `cd ~/app`. <br/> Modify the contents of the `.env` file. ( Eg: `vim .env` )
|
||||
|
||||
The default `.env` file looks like this:
|
||||
```bash
|
||||
TOOLJET_HOST=http://<example>
|
||||
LOCKBOX_MASTER_KEY=<example>
|
||||
SECRET_KEY_BASE=<example>
|
||||
PG_DB=tooljet_prod
|
||||
PG_USER=<pg user name>
|
||||
PG_HOST=<pg host>
|
||||
PG_PASS=<pg user password>
|
||||
LOCKBOX_MASTER_KEY=
|
||||
SECRET_KEY_BASE=
|
||||
PG_DB=
|
||||
PG_USER=
|
||||
PG_HOST=
|
||||
PG_PASS=
|
||||
TOOLJET_DB=
|
||||
TOOLJET_DB_HOST=
|
||||
TOOLJET_DB_USER=
|
||||
TOOLJET_DB_PASS=
|
||||
```
|
||||
Read **[environment variables reference](/docs/setup/env-vars)**
|
||||
|
||||
|
|
@ -59,32 +55,30 @@ Follow the steps below to deploy ToolJet on AWS EC2 instances.
|
|||
If there are self signed HTTPS endpoints that ToolJet needs to connect to, please make sure that `NODE_EXTRA_CA_CERTS` environment variable is set to the absolute path containing the certificates.
|
||||
:::
|
||||
|
||||
8. `TOOLJET_HOST` environment variable determines where you can access the ToolJet client. It can either be the public ipv4 address of your instance or a custom domain that you want to use.
|
||||
8. `TOOLJET_DB_HOST` environment variable determines where you can access the ToolJet client. It can either be the public ipv4 address of your instance or a custom domain that you want to use.
|
||||
|
||||
Examples:
|
||||
`TOOLJET_HOST=http://12.34.56.78` or
|
||||
`TOOLJET_HOST=https://yourdomain.com` or
|
||||
`TOOLJET_HOST=https://tooljet.yourdomain.com`
|
||||
`TOOLJET_DB_HOST=http://12.34.56.78` or
|
||||
`TOOLJET_DB_HOST=https://yourdomain.com` or
|
||||
`TOOLJET_DB_HOST=https://tooljet.yourdomain.com`
|
||||
|
||||
:::info
|
||||
We use a [lets encrypt](https://letsencrypt.org/) plugin on top of nginx to create TLS certificates on the fly.
|
||||
:::
|
||||
|
||||
:::info
|
||||
Please make sure that `TOOLJET_HOST` starts with either `http://` or `https://`
|
||||
Please make sure that `TOOLJET_DB_HOST` starts with either `http://` or `https://`
|
||||
:::
|
||||
|
||||
9. Once you've configured the `.env` file, run `./setup_app`. This script will install all the dependencies of ToolJet and then will start the required services.
|
||||
|
||||
10. If you've set a custom domain for `TOOLJET_HOST`, add a `A record` entry in your DNS settings to point to the IP address of the EC2 instance.
|
||||
|
||||
12. You're all done, ToolJet client would now be served at the value you've set in `TOOLJET_HOST`.
|
||||
|
||||
#### Deploying ToolJet Database
|
||||
|
||||
ToolJet AMI comes inbuilt with PostgREST. If you intend to use this feature, you'd only have to setup the environment variables in `~/app/.env` file and run `./setup_app` script.
|
||||
|
||||
You can learn more about this feature [here](/docs/tooljet-database).
|
||||
You can learn more about this feature [here](../tooljet-db/tooljet-database).
|
||||
|
||||
## Upgrading to the Latest LTS Version
|
||||
|
||||
|
|
@ -98,10 +92,4 @@ If this is a new installation of the application, you may start directly with th
|
|||
|
||||
- Users on versions earlier than **v2.23.0-ee2.10.2** must first upgrade to this version before proceeding to the LTS version.
|
||||
|
||||
For specific issues or questions, refer to our **[Slack](https://tooljet.slack.com/join/shared_invite/zt-25438diev-mJ6LIZpJevG0LXCEcL0NhQ#)**.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
*If you have any questions feel free to join our [Slack Community](https://tooljet.com/slack) or send us an email at hello@tooljet.com.*
|
||||
|
|
|
|||
|
|
@ -34,34 +34,16 @@ To deploy Redis on an ECS cluster, please follow the steps outlined below.
|
|||
Please note that if you already have an existing Redis setup, you can continue using it. However, if you need to create a new Redis service, you can follow the steps provided below.
|
||||
|
||||
- Create a new take definition
|
||||
|
||||
<div style={{textAlign: 'center'}}>
|
||||
|
||||
<img className="screenshot-full" src="/img/setup/ecs/ecs-1.png" alt="ECS Setup" />
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
- Please add container and image tag as shown below:
|
||||
|
||||
- Please add container and image tag as shown below: <br/>
|
||||
**Make sure that you are using redis version 6.x.x**
|
||||
|
||||
<div style={{textAlign: 'center'}}>
|
||||
|
||||
<img className="screenshot-full" src="/img/setup/ecs/ecs-2.png" alt="ECS Setup" />
|
||||
|
||||
</div>
|
||||
|
||||
- Ensure that when creating a service, Redis is integrated into the same cluster where your ToolJet app will be deployed.
|
||||
|
||||
- Ensure that when creating a service, Redis is integrated into the same cluster where your ToolJet app will be deployed. <br/>
|
||||
**Note: Please enable public IP**
|
||||
|
||||
<div style={{textAlign: 'center'}}>
|
||||
|
||||
<img className="screenshot-full" src="/img/setup/ecs/ecs-3.png" alt="ECS Setup" />
|
||||
|
||||
</div>
|
||||
|
||||
## ToolJet
|
||||
|
||||
Follow the steps below to deploy ToolJet on a ECS cluster.
|
||||
|
|
@ -70,108 +52,68 @@ Follow the steps below to deploy ToolJet on a ECS cluster.
|
|||
2. Create a target group and an application load balancer to route traffic onto ToolJet containers. You can [reference](https://docs.aws.amazon.com/AmazonECS/latest/userguide/create-application-load-balancer.html) AWS docs to set it up. Please note that ToolJet server exposes `/api/health`, which you can configure for health checks.
|
||||
|
||||
3. Create task definition for deploying ToolJet app as a service on your preconfigured cluster.
|
||||
1. Select Fargate as launch type compatibility
|
||||
2. Configure IAM roles and set operating system family as Linux.
|
||||
3. Select task size to have 3GB of memory and 1vCpu
|
||||
<img className="screenshot-full" src="/img/setup/ecs/ecs-4.png" alt="ECS Setup" />
|
||||
4. Add container details that is shown: <br/>
|
||||
Specify your container name ex: `ToolJet` <br/>
|
||||
Set the image you intend to deploy. ex: `tooljet/tooljet:EE-LTS-latest` <br/>
|
||||
Update port mappings at container port `3000` for tcp protocol.
|
||||
<img className="screenshot-full" src="/img/setup/ecs/ecs-5.png" alt="ECS Setup" />
|
||||
|
||||
i. Select Fargate as launch type compatibility
|
||||
|
||||
ii. Configure IAM roles and set operating system family as Linux.
|
||||
|
||||
iii. Select task size to have 3GB of memory and 1vCpu
|
||||
Specify environmental values for the container. You'd want to make use of secrets to store sensitive information or credentials, kindly refer the AWS [docs](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data-secrets.html) to set it up. You can also store the env in S3 bucket, kindly refer the AWS [docs](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/taskdef-envfiles.html) .
|
||||
<img className="screenshot-full" src="/img/setup/ecs/ecs-6.png" alt="ECS Setup" />
|
||||
|
||||
<div style={{textAlign: 'center'}}>
|
||||
:::info
|
||||
For the setup, ToolJet requires:
|
||||
<ul>
|
||||
- **TOOLJET_DB**
|
||||
- **TOOLJET_DB_HOST**
|
||||
- **TOOLJET_DB_USER**
|
||||
- **TOOLJET_DB_PASS**
|
||||
- **PG_HOST**
|
||||
- **PG_DB**
|
||||
- **PG_USER**
|
||||
- **PG_PASS**
|
||||
- **SECRET_KEY_BASE**
|
||||
- **LOCKBOX_KEY**
|
||||
</ul>
|
||||
<br/>
|
||||
Read **[environment variables reference](./env-vars)**
|
||||
:::
|
||||
|
||||
<img className="screenshot-full" src="/img/setup/ecs/ecs-4.png" alt="ECS Setup" />
|
||||
|
||||
</div>
|
||||
|
||||
iv. Add container details that is shown:
|
||||
|
||||
Specify your container name ex: `ToolJet`
|
||||
|
||||
Set the image you intend to deploy. ex: `tooljet/tooljet:EE-LTS-latest`
|
||||
|
||||
Update port mappings at container port `3000` for tcp protocol.
|
||||
|
||||
<div style={{textAlign: 'center'}}>
|
||||
|
||||
<img className="screenshot-full" src="/img/setup/ecs/ecs-5.png" alt="ECS Setup" />
|
||||
|
||||
</div>
|
||||
|
||||
Specify environmental values for the container. You'd want to make use of secrets to store sensitive information or credentials, kindly refer the AWS [docs](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data-secrets.html) to set it up. You can also store the env in S3 bucket, kindly refer the AWS [docs](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/taskdef-envfiles.html) .
|
||||
|
||||
<div style={{textAlign: 'center'}}>
|
||||
|
||||
<img className="screenshot-full" src="/img/setup/ecs/ecs-6.png" alt="ECS Setup" />
|
||||
|
||||
</div>
|
||||
|
||||
:::info
|
||||
For the minimal setup, ToolJet requires: `TOOLJET_HOST`, `PG_HOST`, `PG_DB`, `PG_USER`, `PG_PASSWORD`, `SECRET_KEY_BASE` & `LOCKBOX_MASTER_KEY` keys in the secret.
|
||||
|
||||
Read **[environment variables reference](https://docs.tooljet.com/docs/setup/env-vars)**
|
||||
:::
|
||||
|
||||
Additionally, include the Redis environment variables within the ToolJet container mentioned above if you have followed the previous steps to create Redis.
|
||||
|
||||
```
|
||||
REDIS_HOST=<public ip of redis task>
|
||||
REDIS_PORT=6379
|
||||
REDIS_USER=default
|
||||
REDIS_PASSWORD=
|
||||
```
|
||||
|
||||
v. Make sure `Use log collection checked` and `Docker configuration` with the command `npm run start:dev`
|
||||
|
||||
<div style={{textAlign: 'center'}}>
|
||||
|
||||
<img className="screenshot-full" src="/img/setup/ecs/ecs-8.png" alt="ECS Setup" />
|
||||
|
||||
</div>
|
||||
Additionally, include the Redis environment variables within the ToolJet container mentioned above if you have followed the previous steps to create Redis.
|
||||
```
|
||||
REDIS_HOST=<public ip of redis task>
|
||||
REDIS_PORT=6379
|
||||
REDIS_USER=default
|
||||
REDIS_PASSWORD=
|
||||
```
|
||||
5. Make sure `Use log collection checked` and `Docker configuration` with the command `npm run start:dev`
|
||||
<img className="screenshot-full" src="/img/setup/ecs/ecs-8.png" alt="ECS Setup" />
|
||||
|
||||
4. Create a service to run your task definition within your cluster.
|
||||
|
||||
- Select the cluster which you have created
|
||||
|
||||
- Select launch type as Fargate
|
||||
|
||||
<div style={{textAlign: 'center'}}>
|
||||
|
||||
<img className="screenshot-full" src="/img/setup/ecs/ecs-9.png" alt="ECS Setup" />
|
||||
|
||||
</div>
|
||||
|
||||
<img className="screenshot-full" src="/img/setup/ecs/ecs-9.png" alt="ECS Setup" />
|
||||
- Select the cluster and set the service name
|
||||
|
||||
- You can set the number of tasks to start with as two
|
||||
|
||||
- Rest of the values can be kept as default
|
||||
|
||||
<div style={{textAlign: 'center'}}>
|
||||
|
||||
<img className="screenshot-full" src="/img/setup/ecs/ecs-10.png" alt="ECS Setup" />
|
||||
|
||||
</div>
|
||||
|
||||
<img className="screenshot-full" src="/img/setup/ecs/ecs-10.png" alt="ECS Setup" />
|
||||
- Click on next step to configure networking options
|
||||
|
||||
- Select your designated VPC, Subnets and Security groups. Kindly ensure that the security group allows for inbound traffic to http port 3000 for the task.
|
||||
|
||||
<div style={{textAlign: 'center'}}>
|
||||
|
||||
<img className="screenshot-full" src="/img/setup/ecs/ecs-11.png" alt="ECS Setup" />
|
||||
|
||||
</div>
|
||||
|
||||
<img className="screenshot-full" src="/img/setup/ecs/ecs-11.png" alt="ECS Setup" />
|
||||
- Since migrations are run as a part of container boot, please specify health check grace period for 900 seconds. Select the application loadbalancer option and set the target group name to the one we had created earlier. This will auto populate the health check endpoints.
|
||||
|
||||
:::info
|
||||
The setup above is just a template. Feel free to update the task definition and configure parameters for resources and environment variables according to your needs.
|
||||
:::
|
||||
|
||||
|
||||
## ToolJet Database
|
||||
|
||||
If you intend to use this feature, you'd have to set up and deploy PostgREST server which helps querying ToolJet Database. You can learn more about this feature [here](https://docs.tooljet.com/docs/tooljet-database).
|
||||
To use ToolJet Database, you'd have to set up and deploy PostgREST server which helps querying ToolJet Database. You can learn more about this feature [here](../tooljet-db/tooljet-database).
|
||||
|
||||
Follow the steps below to deploy PostgREST on a ECS cluster.
|
||||
|
||||
|
|
@ -191,7 +133,7 @@ Follow the steps below to deploy PostgREST on a ECS cluster.
|
|||
|
||||
</div>
|
||||
|
||||
Under environmental variable please add corresponding PostgREST env variables. You can also refer [env variable](https://docs.tooljet.com/docs/setup/env-vars/#postgrest-server-optional).
|
||||
Under environmental variable please add corresponding PostgREST env variables. You can also refer [env variable](./env-vars/#postgrest-server-optional).
|
||||
|
||||
<div style={{textAlign: 'center'}}>
|
||||
|
||||
|
|
@ -225,7 +167,7 @@ Follow the steps below to deploy PostgREST on a ECS cluster.
|
|||
|
||||
</div>
|
||||
|
||||
Update ToolJet deployment with the appropriate env variables [here](https://docs.tooljet.com/docs/setup/env-vars/#enable-tooljet-database--optional-) and apply the changes.
|
||||
Update ToolJet deployment with the appropriate env variables [here](./env-vars/#enable-tooljet-database--optional-) and apply the changes.
|
||||
|
||||
## Upgrading to the Latest LTS Version
|
||||
|
||||
|
|
@ -239,5 +181,4 @@ If this is a new installation of the application, you may start directly with th
|
|||
|
||||
- Users on versions earlier than **v2.23.0-ee2.10.2** must first upgrade to this version before proceeding to the LTS version.
|
||||
|
||||
For specific issues or questions, refer to our **[Slack](https://tooljet.slack.com/join/shared_invite/zt-25438diev-mJ6LIZpJevG0LXCEcL0NhQ#)**.
|
||||
|
||||
*If you have any questions feel free to join our [Slack Community](https://tooljet.com/slack) or send us an email at hello@tooljet.com.*
|
||||
|
|
|
|||
|
|
@ -92,11 +92,10 @@ Use this environment variable to enable/disable the developement mode that allow
|
|||
| ---------------- | ----------------------------------------------- |
|
||||
| USER_SESSION_EXPIRY | This variable controls the user session expiry time. By default, the session expires after **10** days. The variable expects the value in minutes. ex: USER_SESSION_EXPIRY = 120 which is 2 hours |
|
||||
|
||||
### Enable ToolJet Database ( optional )
|
||||
### Enable ToolJet Database ( required )
|
||||
|
||||
| variable | description |
|
||||
| ----------------- | -------------------------------------------- |
|
||||
| ENABLE_TOOLJET_DB | `true` or `false` |
|
||||
| TOOLJET_DB | Default value is `tooljet_db` |
|
||||
| TOOLJET_DB_HOST | database host |
|
||||
| TOOLJET_DB_USER | database username |
|
||||
|
|
|
|||
|
|
@ -9,11 +9,8 @@ title: Google Cloud Run
|
|||
You should setup a PostgreSQL database manually to be used by ToolJet.
|
||||
:::
|
||||
|
||||
*If you have any questions feel free to join our [Slack Community](https://tooljet.com/slack) or send us an email at hello@tooljet.com.*
|
||||
|
||||
Follow the steps below to deploy ToolJet on Cloud run with `gcloud` CLI.
|
||||
|
||||
|
||||
## Deploying ToolJet application
|
||||
1. Create a new Google Cloud Run Service:
|
||||
|
||||
|
|
@ -72,13 +69,9 @@ Click on deploy once the above parameters are set.
|
|||
Once the Service is created and live, to make the Cloud Service URL public. Please follow the steps [**here**](https://cloud.google.com/run/docs/securing/managing-access) to make the service public.
|
||||
:::
|
||||
|
||||
## Deploying ToolJet Database
|
||||
|
||||
|
||||
|
||||
|
||||
### Deploying ToolJet Database
|
||||
|
||||
If you intend to use this feature, you'd have to set up and deploy PostgREST server which helps querying ToolJet Database.
|
||||
To use ToolJet Database, you'd have to set up and deploy PostgREST server which helps querying ToolJet Database.
|
||||
|
||||
#### PostgREST server
|
||||
|
||||
|
|
@ -120,7 +113,7 @@ If you intend to use this feature, you'd have to set up and deploy PostgREST ser
|
|||
<img className="screenshot-full" src="/img/cloud-run/port-and-capacity-postgrest.png" alt="port-and-capacity-postgrest" />
|
||||
</div>
|
||||
|
||||
5. Under environmental variable please add corresponding ToolJet database env variables. You can also refer [env variable](/docs/setup/env-vars/#enable-tooljet-database--optional-).
|
||||
5. Under environmental variable please add corresponding ToolJet database env variables. You can also refer [env variable](./env-vars/#enable-tooljet-database--optional-).
|
||||
|
||||
6. Please go to connection tab. Under Cloud SQL instance please select the PostgreSQL database which you have set-up for ToolJet application or the separate PostgreSQL database created respective to ToolJet Database from the drop-down option.
|
||||
|
||||
|
|
@ -138,7 +131,7 @@ Once the Service is created and live, to make the Cloud Service URL public. Ple
|
|||
|
||||
|
||||
|
||||
7. Additional Environmental variable to be added to ToolJet application or ToolJet Server connect to PostgREST server. You can also refer env variable [**here**](/docs/setup/env-vars/#enable-tooljet-database--optional-)
|
||||
7. Additional Environmental variable to be added to ToolJet application or ToolJet Server connect to PostgREST server. You can also refer env variable [**here**](./env-vars/#enable-tooljet-database--optional-)
|
||||
|
||||
|
||||
<div style={{textAlign: 'center'}}>
|
||||
|
|
@ -158,4 +151,4 @@ If this is a new installation of the application, you may start directly with th
|
|||
|
||||
- Users on versions earlier than **v2.23.0-ee2.10.2** must first upgrade to this version before proceeding to the LTS version.
|
||||
|
||||
For specific issues or questions, refer to our **[Slack](https://tooljet.slack.com/join/shared_invite/zt-25438diev-mJ6LIZpJevG0LXCEcL0NhQ#)**.
|
||||
*If you have any questions feel free to join our [Slack Community](https://tooljet.com/slack) or send us an email at hello@tooljet.com.*
|
||||
|
|
|
|||
|
|
@ -7,8 +7,6 @@ title: Helm
|
|||
|
||||
This repository contains Helm charts for deploying [ToolJet](https://github.com/ToolJet/helm-charts) on a Kubernetes Cluster using Helm v3. The charts include an integrated PostgreSQL server that is enabled by default. However, you have the option to disable it and configure a different PostgreSQL server by updating the `values.yml` file.
|
||||
|
||||
*If you have any questions feel free to join our [Slack Community](https://tooljet.com/slack) or send us an email at hello@tooljet.com.*
|
||||
|
||||
## Installation
|
||||
|
||||
### From Helm repo
|
||||
|
|
@ -17,21 +15,21 @@ helm repo add tooljet https://github.com/ToolJet/helm-charts.git
|
|||
helm install tooljet tooljet/tooljet
|
||||
```
|
||||
|
||||
### From the source
|
||||
### From the Source
|
||||
1. Clone the repository and navigate to this directory
|
||||
2. Run `helm dependency update
|
||||
2. Run `helm dependency update`
|
||||
3. It is recommended but optional to modify the values in the `values.yaml` file, such as usernames, passwords, persistence settings, etc.
|
||||
4. Run `helm install -n $NAMESPACE --create-namespace $RELEASE .`
|
||||
|
||||
Remember to replace the variables with your specific configuration values.
|
||||
|
||||
**ToolJet Database**
|
||||
## ToolJet Database
|
||||
|
||||
ToolJet offers a hosted database solution that allows you to build applications quickly and manage your data effortlessly. The ToolJet database requires no setup and provides a user-friendly interface for data management.
|
||||
|
||||
For more information about the ToolJet database, you can visit [here](/docs/tooljet-database).
|
||||
For more information about the ToolJet database, you can visit [here](../tooljet-db/tooljet-database).
|
||||
|
||||
If you plan to use this feature, you need to set up and deploy the PostgREST server, which facilitates querying the ToolJet Database.
|
||||
You need to set up and deploy the PostgREST server, which facilitates querying the ToolJet Database.
|
||||
|
||||
To enable the ToolJet database, please set the environment variable `ENABLE_TOOLJET_DB` to true in the `values.yaml` file.
|
||||
|
||||
|
|
@ -47,4 +45,4 @@ If this is a new installation of the application, you may start directly with th
|
|||
|
||||
- Users on versions earlier than **v2.23.0-ee2.10.2** must first upgrade to this version before proceeding to the LTS version.
|
||||
|
||||
For specific issues or questions, refer to our **[Slack](https://tooljet.slack.com/join/shared_invite/zt-25438diev-mJ6LIZpJevG0LXCEcL0NhQ#)**.
|
||||
*If you have any questions feel free to join our [Slack Community](https://tooljet.com/slack) or send us an email at hello@tooljet.com.*
|
||||
|
|
|
|||
|
|
@ -9,8 +9,6 @@ title: Kubernetes (AKS)
|
|||
You should setup a PostgreSQL database manually to be used by ToolJet. We recommend using Azure Database for PostgreSQL since this guide is for deploying using AKS.
|
||||
:::
|
||||
|
||||
*If you have any questions feel free to join our [Slack Community](https://tooljet.com/slack) or send us an email at hello@tooljet.com.*
|
||||
|
||||
Follow the steps below to deploy ToolJet on a AKS Kubernetes cluster.
|
||||
|
||||
1. Create an AKS cluster and connect to it to start with the deployment. You can follow the steps as mentioned on the [Azure's documentation](https://docs.microsoft.com/en-us/azure/aks/kubernetes-walkthrough-portal).
|
||||
|
|
@ -21,7 +19,25 @@ Follow the steps below to deploy ToolJet on a AKS Kubernetes cluster.
|
|||
curl -LO https://tooljet-deployments.s3.us-west-1.amazonaws.com/kubernetes/AKS/deployment.yaml
|
||||
```
|
||||
|
||||
Make sure to edit the environment variables in the `deployment.yaml`. We advise to use secrets to setup sensitive information. You can check out the available options [here](https://docs.tooljet.com/docs/setup/env-vars).
|
||||
:::info
|
||||
For the setup, ToolJet requires:
|
||||
<ul>
|
||||
- **TOOLJET_DB**
|
||||
- **TOOLJET_DB_HOST**
|
||||
- **TOOLJET_DB_USER**
|
||||
- **TOOLJET_DB_PASS**
|
||||
- **PG_HOST**
|
||||
- **PG_DB**
|
||||
- **PG_USER**
|
||||
- **PG_PASS**
|
||||
- **SECRET_KEY_BASE**
|
||||
- **LOCKBOX_KEY**
|
||||
</ul>
|
||||
<br/>
|
||||
Read **[environment variables reference](./env-vars)**
|
||||
:::
|
||||
|
||||
Make sure to edit the environment variables in the `deployment.yaml`. We advise to use secrets to setup sensitive information. You can check out the available options [here](./env-vars).
|
||||
|
||||
:::info
|
||||
If there are self signed HTTPS endpoints that ToolJet needs to connect to, please make sure that `NODE_EXTRA_CA_CERTS` environment variable is set to the absolute path containing the certificates. You can make use of kubernetes secrets to mount the certificate file onto the containers.
|
||||
|
|
@ -40,11 +56,9 @@ If there are self signed HTTPS endpoints that ToolJet needs to connect to, pleas
|
|||
|
||||
You will be able to access your ToolJet installation once the pods and services running.
|
||||
|
||||
|
||||
|
||||
## ToolJet Database
|
||||
|
||||
If you intend to use this feature, you'd have to set up and deploy PostgREST server which helps querying ToolJet Database. Please [follow the instructions here](/docs/setup/env-vars/#enable-tooljet-database--optional-) for additional environment variables configuration to be done.
|
||||
To use ToolJet Database, you'd have to set up and deploy PostgREST server which helps querying ToolJet Database. Please [follow the instructions here](./env-vars/#enable-tooljet-database-required).
|
||||
|
||||
1. Setup PostgREST server
|
||||
|
||||
|
|
@ -66,4 +80,4 @@ If this is a new installation of the application, you may start directly with th
|
|||
|
||||
- Users on versions earlier than **v2.23.0-ee2.10.2** must first upgrade to this version before proceeding to the LTS version.
|
||||
|
||||
For specific issues or questions, refer to our **[Slack](https://tooljet.slack.com/join/shared_invite/zt-25438diev-mJ6LIZpJevG0LXCEcL0NhQ#)**.
|
||||
*If you have any questions feel free to join our [Slack Community](https://tooljet.com/slack) or send us an email at hello@tooljet.com.*
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ title: Kubernetes (EKS)
|
|||
Follow the steps below to deploy ToolJet on an EKS Kubernetes cluster.
|
||||
|
||||
:::info
|
||||
You should set up a PostgreSQL database manually to be used by ToolJet. We recommend using an RDS PostgreSQL database. You can find the system requirements [here](https://docs.tooljet.com/docs/setup/system-requirements#database-software)
|
||||
You should set up a PostgreSQL database manually to be used by ToolJet. We recommend using an RDS PostgreSQL database. You can find the system requirements [here](./system-requirements#database-software)
|
||||
:::
|
||||
|
||||
1. Create an EKS cluster and connect to it to start with the deployment. You can follow the steps as mentioned in the [AWS documentation](https://docs.aws.amazon.com/eks/latest/userguide/create-cluster.html).
|
||||
|
|
@ -19,7 +19,25 @@ _The file below is just a template and might not suit production environments. Y
|
|||
kubectl apply -f https://tooljet-deployments.s3.us-west-1.amazonaws.com/kubernetes/deployment.yaml
|
||||
```
|
||||
|
||||
Make sure to edit the environment variables in the `deployment.yaml`. We advise using secrets to set up sensitive information. You can check out the available options [here](https://docs.tooljet.com/docs/setup/env-vars).
|
||||
Make sure to edit the environment variables in the `deployment.yaml`. We advise using secrets to set up sensitive information. You can check out the available options [here](./env-vars).
|
||||
|
||||
:::info
|
||||
For the setup, ToolJet requires:
|
||||
<ul>
|
||||
- **TOOLJET_DB**
|
||||
- **TOOLJET_DB_HOST**
|
||||
- **TOOLJET_DB_USER**
|
||||
- **TOOLJET_DB_PASS**
|
||||
- **PG_HOST**
|
||||
- **PG_DB**
|
||||
- **PG_USER**
|
||||
- **PG_PASS**
|
||||
- **SECRET_KEY_BASE**
|
||||
- **LOCKBOX_KEY**
|
||||
</ul>
|
||||
<br/>
|
||||
Read **[environment variables reference](./env-vars)**
|
||||
:::
|
||||
|
||||
3. Create a Kubernetes service to publish the Kubernetes deployment that you have created. We have a [template](https://tooljet-deployments.s3.us-west-1.amazonaws.com/kubernetes/service.yaml) for exposing the ToolJet server as a service using an AWS Load Balancer.
|
||||
|
||||
|
|
@ -28,7 +46,7 @@ Make sure to edit the environment variables in the `deployment.yaml`. We advise
|
|||
|
||||
## ToolJet Database
|
||||
|
||||
If you intend to use this feature, you'd have to set up and deploy a PostgREST server, which helps in querying the ToolJet Database. Please [follow the instructions here](https://docs.tooljet.com/docs/setup/env-vars/#enable-tooljet-database--optional-) for additional environment variables configuration.
|
||||
To use ToolJet Database, you'd have to set up and deploy a PostgREST server, which helps in querying the ToolJet Database. Please [follow the instructions here](./env-vars/#enable-tooljet-database-required).
|
||||
|
||||
1. Set up PostgREST server
|
||||
|
||||
|
|
@ -50,4 +68,4 @@ If this is a new installation of the application, you may start directly with th
|
|||
|
||||
- Users on versions earlier than **v2.23.0-ee2.10.2** must first upgrade to this version before proceeding to the LTS version.
|
||||
|
||||
For specific issues or questions, refer to our **[Slack](https://tooljet.slack.com/join/shared_invite/zt-25438diev-mJ6LIZpJevG0LXCEcL0NhQ#)**.
|
||||
*If you have any questions feel free to join our [Slack Community](https://tooljet.com/slack) or send us an email at hello@tooljet.com.*
|
||||
|
|
|
|||
|
|
@ -9,8 +9,6 @@ title: Kubernetes (GKE)
|
|||
You should setup a PostgreSQL database manually to be used by ToolJet. We recommend using Cloud SQL since this guide is for deploying using GKE.
|
||||
:::
|
||||
|
||||
*If you have any questions feel free to join our [Slack Community](https://tooljet.com/slack) or send us an email at hello@tooljet.com.*
|
||||
|
||||
Follow the steps below to deploy ToolJet on a GKE Kubernetes cluster.
|
||||
|
||||
1. Create an SSL certificate.
|
||||
|
|
@ -33,7 +31,24 @@ gcloud compute addresses create tj-static-ip --global
|
|||
curl -LO https://tooljet-deployments.s3.us-west-1.amazonaws.com/kubernetes/GKE/deployment.yaml
|
||||
```
|
||||
|
||||
Make sure to edit the environment variables in the `deployment.yaml`. You can check out the available options [here](https://docs.tooljet.com/docs/setup/env-vars).
|
||||
Make sure to edit the environment variables in the `deployment.yaml`. You can check out the available options [here](./env-vars).
|
||||
|
||||
:::info
|
||||
For the setup, ToolJet requires:
|
||||
<ul>
|
||||
- **TOOLJET_DB**
|
||||
- **TOOLJET_DB_HOST**
|
||||
- **TOOLJET_DB_USER**
|
||||
- **TOOLJET_DB_PASS**
|
||||
- **PG_HOST**
|
||||
- **PG_DB**
|
||||
- **PG_USER**
|
||||
- **PG_PASS**
|
||||
- **SECRET_KEY_BASE**
|
||||
- **LOCKBOX_KEY**
|
||||
</ul>
|
||||
Read **[environment variables reference](./env-vars)**
|
||||
:::
|
||||
|
||||
:::info
|
||||
If there are self signed HTTPS endpoints that ToolJet needs to connect to, please make sure that `NODE_EXTRA_CA_CERTS` environment variable is set to the absolute path containing the certificates. You can make use of kubernetes secrets to mount the certificate file onto the containers.
|
||||
|
|
@ -65,12 +80,9 @@ It might take a few minutes to provision the managed certificates. [Managed cert
|
|||
|
||||
You will be able to access your ToolJet installation once the pods, service and the ingress is running.
|
||||
|
||||
|
||||
|
||||
|
||||
## ToolJet Database
|
||||
|
||||
If you intend to use this feature, you'd have to set up and deploy PostgREST server which helps querying ToolJet Database. Please [follow the instructions here](/docs/setup/env-vars/#enable-tooljet-database--optional-) for additional environment variables configuration to be done.
|
||||
To use ToolJet Database, you'd have to set up and deploy PostgREST server which helps querying ToolJet Database. Please [follow the instructions here](./env-vars/#enable-tooljet-database-required).
|
||||
|
||||
1. Setup PostgREST server
|
||||
|
||||
|
|
@ -92,4 +104,4 @@ If this is a new installation of the application, you may start directly with th
|
|||
|
||||
- Users on versions earlier than **v2.23.0-ee2.10.2** must first upgrade to this version before proceeding to the LTS version.
|
||||
|
||||
For specific issues or questions, refer to our **[Slack](https://tooljet.slack.com/join/shared_invite/zt-25438diev-mJ6LIZpJevG0LXCEcL0NhQ#)**.
|
||||
*If you have any questions feel free to join our [Slack Community](https://tooljet.com/slack) or send us an email at hello@tooljet.com.*
|
||||
|
|
|
|||
|
|
@ -9,17 +9,25 @@ title: Kubernetes
|
|||
You should setup a PostgreSQL database manually to be used by ToolJet.
|
||||
:::
|
||||
|
||||
*If you have any questions feel free to join our [Slack Community](https://tooljet.com/slack) or send us an email at hello@tooljet.com.*
|
||||
|
||||
Follow the steps below to deploy ToolJet on a Kubernetes cluster.
|
||||
|
||||
1. Setup a PostgreSQL database
|
||||
1. **Setup a PostgreSQL database** <br/>
|
||||
ToolJet uses a postgres database as the persistent storage for storing data related to users and apps. We do not have plans to support other databases such as MySQL.
|
||||
2. **Create a Kubernetes secret with name `server`.** <br/>
|
||||
For the setup, ToolJet requires:
|
||||
|
||||
- **TOOLJET_DB**
|
||||
- **TOOLJET_DB_HOST**
|
||||
- **TOOLJET_DB_USER**
|
||||
- **TOOLJET_DB_PASS**
|
||||
- **PG_HOST**
|
||||
- **PG_DB**
|
||||
- **PG_USER**
|
||||
- **PG_PASS**
|
||||
- **SECRET_KEY_BASE**
|
||||
- **LOCKBOX_KEY**
|
||||
|
||||
2. Create a Kubernetes secret with name `server`. For the minimal setup, ToolJet requires `pg_host`, `pg_db`, `pg_user`, `pg_password`, `secret_key_base` & `lockbox_key` keys in the secret.
|
||||
|
||||
Read **[environment variables reference](/docs/setup/env-vars)**
|
||||
|
||||
Read **[environment variables reference](./env-vars)**
|
||||
3. Create a Kubernetes deployment
|
||||
|
||||
```bash
|
||||
|
|
@ -48,7 +56,7 @@ If there are self signed HTTPS endpoints that ToolJet needs to connect to, pleas
|
|||
- [GKE Ingress for HTTP(S) Load Balancing](https://cloud.google.com/kubernetes-engine/docs/concepts/ingress)
|
||||
|
||||
:::tip
|
||||
If you want to serve ToolJet client from services such as Firebase or Netlify, please read the client Setup documentation **[here](/docs/setup/client)**.
|
||||
If you want to serve ToolJet client from services such as Firebase or Netlify, please read the client Setup documentation **[here](./client)**.
|
||||
:::
|
||||
|
||||
## ToolJet Database
|
||||
|
|
@ -75,4 +83,4 @@ If this is a new installation of the application, you may start directly with th
|
|||
|
||||
- Users on versions earlier than **v2.23.0-ee2.10.2** must first upgrade to this version before proceeding to the LTS version.
|
||||
|
||||
For specific issues or questions, refer to our **[Slack](https://tooljet.slack.com/join/shared_invite/zt-25438diev-mJ6LIZpJevG0LXCEcL0NhQ#)**.
|
||||
*If you have any questions feel free to join our [Slack Community](https://tooljet.com/slack) or send us an email at hello@tooljet.com.*
|
||||
|
|
|
|||
|
|
@ -9,15 +9,23 @@ title: Openshift
|
|||
You should setup a PostgreSQL database manually to be used by ToolJet.
|
||||
:::
|
||||
|
||||
*If you have any questions feel free to join our [Slack Community](https://tooljet.com/slack) or send us an email at hello@tooljet.com.*
|
||||
|
||||
Follow the steps below to deploy ToolJet on Openshift.
|
||||
|
||||
1. Setup a PostgreSQL database ToolJet uses a postgres database as the persistent storage for storing data related to users and apps. We do not have plans to support other databases such as MySQL.
|
||||
|
||||
2. Create a Kubernetes secret with name `server`. For the minimal setup, ToolJet requires `pg_host`, `pg_db`, `pg_user`, `pg_password`, `secret_key_base` & `lockbox_key` keys in the secret.
|
||||
2. Create a Kubernetes secret with name `server`. For the setup, ToolJet requires:
|
||||
- **TOOLJET_DB**
|
||||
- **TOOLJET_DB_HOST**
|
||||
- **TOOLJET_DB_USER**
|
||||
- **TOOLJET_DB_PASS**
|
||||
- **PG_HOST**
|
||||
- **PG_DB**
|
||||
- **PG_USER**
|
||||
- **PG_PASS**
|
||||
- **SECRET_KEY_BASE**
|
||||
- **LOCKBOX_KEY**
|
||||
|
||||
Read **[environment variables reference](https://docs.tooljet.com/docs/setup/env-vars)**
|
||||
Read **[environment variables reference](./env-vars)**
|
||||
|
||||
3. Once you have logged into the Openshift developer dashboard click on `+Add` tab. Select import YAML from the local machine.
|
||||
|
||||
|
|
@ -31,7 +39,6 @@ Copy paste deployment.yaml to the online editor
|
|||
curl -LO https://tooljet-deployments.s3.us-west-1.amazonaws.com/openshift/deployment.yaml
|
||||
```
|
||||
|
||||
|
||||
Copy paste the service.yaml to the online editor
|
||||
|
||||
```
|
||||
|
|
@ -46,7 +53,7 @@ curl -LO https://tooljet-deployments.s3.us-west-1.amazonaws.com/openshift/servic
|
|||
|
||||
Once you have added the files click on create.
|
||||
|
||||
:info
|
||||
:::info
|
||||
If there are self signed HTTPS endpoints that ToolJet needs to connect to, please make sure that `NODE_EXTRA_CA_CERTS` environment variable is set to the absolute path containing the certificates. You can make use of kubernetes secrets to mount the certificate file onto the containers.
|
||||
:::
|
||||
|
||||
|
|
@ -61,9 +68,9 @@ If there are self signed HTTPS endpoints that ToolJet needs to connect to, pleas
|
|||
|
||||
## ToolJet Database
|
||||
|
||||
You can know more about tooljet database [here](https://docs.tooljet.com/docs/tooljet-database)
|
||||
You can know more about tooljet database [here](../tooljet-db/tooljet-database)
|
||||
|
||||
If you intend to use this feature, you'd have to set up and deploy PostgREST server which helps querying ToolJet Database. Please [follow the instructions here](https://docs.tooljet.com/docs/setup/env-vars/#enable-tooljet-database--optional-) for additional environment variables configuration to be done.
|
||||
To use ToolJet Database, you'd have to set up and deploy PostgREST server which helps querying ToolJet Database. Please [follow the instructions here](./env-vars/#enable-tooljet-database-required).
|
||||
|
||||
```
|
||||
https://tooljet-deployments.s3.us-west-1.amazonaws.com/openshift/postgrest.yaml
|
||||
|
|
@ -81,4 +88,4 @@ If this is a new installation of the application, you may start directly with th
|
|||
|
||||
- Users on versions earlier than **v2.23.0-ee2.10.2** must first upgrade to this version before proceeding to the LTS version.
|
||||
|
||||
For specific issues or questions, refer to our **[Slack](https://tooljet.slack.com/join/shared_invite/zt-25438diev-mJ6LIZpJevG0LXCEcL0NhQ#)**.
|
||||
*If you have any questions feel free to join our [Slack Community](https://tooljet.com/slack) or send us an email at hello@tooljet.com.*
|
||||
|
|
|
|||
|
|
@ -5,8 +5,6 @@ title: Deploying ToolJet on a subpath
|
|||
|
||||
ToolJet can now be deployed at a subpath rather than the root (`/`) of a public domain. Example subpath installation URL: **`http://www.yourcompany.com/apps/tooljet`**
|
||||
|
||||
*If you have any questions feel free to join our [Slack Community](https://tooljet.com/slack) or send us an email at hello@tooljet.com.*
|
||||
|
||||
You'll need to setup the following environment variables if ToolJet installation is on a domain subpath:
|
||||
|
||||
| variable | value |
|
||||
|
|
@ -16,7 +14,7 @@ You'll need to setup the following environment variables if ToolJet installation
|
|||
|
||||
|
||||
:::info
|
||||
See all **[Environment Variables](/docs/setup/env-vars)** here.
|
||||
See all **[Environment Variables](./env-vars)** here.
|
||||
:::
|
||||
|
||||
## Upgrading to the Latest Version
|
||||
|
|
@ -33,6 +31,4 @@ If this is a new installation of the application, you may start directly with th
|
|||
|
||||
- Users on versions earlier than v2.23.0-ee2.10.2 must first upgrade to this version before proceeding to the latest version.
|
||||
|
||||
For specific issues or questions, refer to our **[Slack](https://tooljet.slack.com/join/shared_invite/zt-25438diev-mJ6LIZpJevG0LXCEcL0NhQ#)**.
|
||||
|
||||
|
||||
*If you have any questions feel free to join our [Slack Community](https://tooljet.com/slack) or send us an email at hello@tooljet.com.*
|
||||
|
|
|
|||
|
|
@ -18,14 +18,12 @@ docker run \
|
|||
-v tooljet_data:/var/lib/postgresql/13/main \
|
||||
tooljet/try:EE-LTS-latest
|
||||
```
|
||||
*If you have any questions feel free to join our [Slack Community](https://tooljet.com/slack) or send us an email at hello@tooljet.com.*
|
||||
|
||||
|
||||
#### Setup information
|
||||
|
||||
- Runs the ToolJet server on the port 80 on your machine.
|
||||
- Container has postgres already configured within. All the data will be available in the docker volume `tooljet_data`.
|
||||
- You can make use of `--env` or `--env-file` flag to test against various env configurables mentioned [here](https://docs.tooljet.com/docs/setup/env-vars).
|
||||
- You can make use of `--env` or `--env-file` flag to test against various env configurables mentioned [here](./env-vars).
|
||||
- Use `docker stop tooljet` to stop the container and `docker start tooljet` to start the container thereafter.
|
||||
|
||||
#### Dynamic Port Setup
|
||||
|
|
@ -47,5 +45,4 @@ docker run \
|
|||
|
||||
By following these instructions, you can easily run the ToolJet server on the port of your choice, ensuring flexibility in your setup.
|
||||
|
||||
|
||||
|
||||
*If you have any questions feel free to join our [Slack Community](https://tooljet.com/slack) or send us an email at hello@tooljet.com.*
|
||||
|
|
|
|||
|
|
@ -20,16 +20,14 @@ ToolJet will be releasing new LTS versions every 3-5 months with an end-of-life
|
|||
|
||||
The upgrade process depends on your deployment method. You can follow the upgrade process under the respective setup guides:
|
||||
|
||||
- [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 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)
|
||||
- [Upgrade ToolJet on Kubernetes](/docs/setup/kubernetes#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on Kubernetes(GKE)](/docs/setup/kubernetes-gke#upgrading-to-the-latest-lts-version)
|
||||
- [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)
|
||||
|
||||
|
||||
- [Upgrade ToolJet on DigitalOcean](./digitalocean#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on Docker](./docker#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on AWS EC2](./ec2#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on AWS ECS](./ecs#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on OpenShift](./openshift#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on Helm](./helm#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on Kubernetes](./kubernetes#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on Kubernetes(GKE)](./kubernetes-gke#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on Kubernetes(AKS)](./kubernetes-aks#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on Azure Container Apps](./azure-container#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on Google Cloud Run](./google-cloud-run#upgrading-to-the-latest-lts-version)
|
||||
|
|
|
|||
|
|
@ -26,7 +26,7 @@ Before attempting to upgrade to the ToolJet 3.0:
|
|||
To upgrade, update your Docker image to:
|
||||
|
||||
```bash
|
||||
tooljet/tooljet:v3.0.0-ee-beta.1
|
||||
tooljet/tooljet:v3.0.0-ee-lts
|
||||
```
|
||||
:::warning
|
||||
This is a beta release. Test thoroughly in a non-production environment first.
|
||||
|
|
@ -224,7 +224,9 @@ The `metadata` object will contain detailed information about the request and re
|
|||
|
||||
### ToolJet Database
|
||||
|
||||
ToolJet Database is now a core requirement for the 3.0. The ToolJet Database will be automatically enabled and configured by default.
|
||||
ToolJet Database is now a core requirement for the 3.0.
|
||||
To use ToolJet Database, you'd have to set up and deploy PostgREST server which helps querying ToolJet Database. Please [follow the instructions here](./env-vars/#enable-tooljet-database-required).
|
||||
|
||||
|
||||
## Help and Support
|
||||
|
||||
|
|
|
|||
|
|
@ -8,12 +8,11 @@ ToolJet version 2 comes with a bunch of exciting features, with the major ones b
|
|||
1. Multi page
|
||||
2. Multi env
|
||||
3. Forms widget
|
||||
4. [Database](/docs/tooljet-database) (Requires opt-in)
|
||||
5. [Marketplace](/docs/marketplace) (Requires opt-in)
|
||||
4. [Database](../tooljet-db/tooljet-database) (Requires opt-in)
|
||||
5. [Marketplace](../marketplace/marketplace-overview) (Requires opt-in)
|
||||
|
||||
Checkout the latest changelog for v2 [here](https://github.com/ToolJet/ToolJet/releases).
|
||||
|
||||
*If you have any questions feel free to join our [Slack Community](https://tooljet.com/slack) or send us an email at hello@tooljet.com.*
|
||||
## Deployment
|
||||
|
||||
Based on your opted deployment method from our [setup doc](/docs/setup/), you can directly deploy v2 without any additional configuration for the default setup.
|
||||
|
|
|
|||
|
|
@ -9,8 +9,6 @@ title: Azure container apps
|
|||
Please note that you need to set up a PostgreSQL database manually to be used by ToolJet. Additionally, you must set up a Redis service through Azure Cache for Redis.
|
||||
:::
|
||||
|
||||
*If you have any questions feel free to join our [Slack Community](https://tooljet.com/slack) or send us an email at hello@tooljet.com.*
|
||||
|
||||
## Deploying ToolJet application
|
||||
|
||||
1. Open the Azure dashboard at https://portal.azure.com, navigate to Container Apps, and click on "Create container app".
|
||||
|
|
@ -35,9 +33,19 @@ Please note that you need to set up a PostgreSQL database manually to be used by
|
|||
</div>
|
||||
|
||||
- Make sure to provide the image tag, and then enter `server/entrypoint.sh, npm, run, start:prod` in the "Command override" field.
|
||||
- Add the following ToolJet application variables under the "Environmental variable" section. You can refer to this [**documentation**](/docs/setup/env-vars) for more information on environment variables.
|
||||
- Add the following ToolJet application variables under the "Environmental variable" section. You can refer to this [**documentation**](./env-vars) for more information on environment variables.
|
||||
|
||||
**Note: For the minimal setup, ToolJet requires: `TOOLJET_HOST`, `PG_HOST`, `PG_DB`, `PG_USER`, `PG_PASSWORD`, `SECRET_KEY_BASE` & `LOCKBOX_MASTER_KEY` keys in the secret.**
|
||||
**Note**: ToolJet requires:
|
||||
- **TOOLJET_DB**
|
||||
- **TOOLJET_DB_HOST**
|
||||
- **TOOLJET_DB_USER**
|
||||
- **TOOLJET_DB_PASS**
|
||||
- **PG_HOST**
|
||||
- **PG_DB**
|
||||
- **PG_USER**
|
||||
- **PG_PASS**
|
||||
- **SECRET_KEY_BASE**
|
||||
- **LOCKBOX_KEY**
|
||||
|
||||
<div style={{textAlign: 'center'}}>
|
||||
|
||||
|
|
@ -109,7 +117,7 @@ If you already have Redis configured, you can use your existing setup. Otherwise
|
|||
|
||||
## Upgrading to the Latest LTS Version
|
||||
|
||||
New LTS versions are released every 3-5 months with an end-of-life of atleast 18 months. To check the latest LTS version, visit the [ToolJet Docker Hub](https://hub.docker.com/r/tooljet/tooljet/tags) page. The LTS tags follow a naming convention with the prefix `LTS-` followed by the version number, for example `tooljet/tooljet:EE-LTS-latest`.
|
||||
New LTS versions are released every 3-5 months with an end-of-life of atleast 18 months. To check the latest LTS version, visit the [ToolJet Docker Hub](https://hub.docker.com/r/tooljet/tooljet/tags) page. The LTS tags follow a naming convention with the prefix `LTS-` followed by the version number, for example `tooljet/tooljet:ee-lts-latest`.
|
||||
|
||||
If this is a new installation of the application, you may start directly with the latest version. This guide is not required for new installations.
|
||||
|
||||
|
|
@ -119,5 +127,4 @@ If this is a new installation of the application, you may start directly with th
|
|||
|
||||
- Users on versions earlier than **v2.23.0-ee2.10.2** must first upgrade to this version before proceeding to the LTS version.
|
||||
|
||||
For specific issues or questions, refer to our **[Slack](https://tooljet.slack.com/join/shared_invite/zt-25438diev-mJ6LIZpJevG0LXCEcL0NhQ#)**.
|
||||
|
||||
*If you have any questions feel free to join our [Slack Community](https://tooljet.com/slack) or send us an email at hello@tooljet.com.*
|
||||
|
|
|
|||
|
|
@ -99,7 +99,7 @@ Summarizing the steps below:
|
|||
|
||||
## Upgrading to the Latest LTS Version
|
||||
|
||||
New LTS versions are released every 3-5 months with an end-of-life of atleast 18 months. To check the latest LTS version, visit the [ToolJet Docker Hub](https://hub.docker.com/r/tooljet/tooljet/tags) page. The LTS tags follow a naming convention with the prefix `LTS-` followed by the version number, for example `tooljet/tooljet:EE-LTS-latest`.
|
||||
New LTS versions are released every 3-5 months with an end-of-life of atleast 18 months. To check the latest LTS version, visit the [ToolJet Docker Hub](https://hub.docker.com/r/tooljet/tooljet/tags) page. The LTS tags follow a naming convention with the prefix `LTS-` followed by the version number, for example `tooljet/tooljet:ee-lts-latest`.
|
||||
|
||||
If this is a new installation of the application, you may start directly with the latest version. This guide is not required for new installations.
|
||||
|
||||
|
|
|
|||
|
|
@ -7,8 +7,6 @@ title: DigitalOcean
|
|||
|
||||
Now you can quickly deploy ToolJet using the Deploy to DigitalOcean button.
|
||||
|
||||
If you have any questions feel free to join our [Slack Community](https://tooljet.com/slack) or send us an email at hello@tooljet.com.
|
||||
|
||||
### Redis setup
|
||||
|
||||
:::info
|
||||
|
|
@ -37,7 +35,7 @@ Follow the steps below to configure Redis database:
|
|||
|
||||
## Deploying
|
||||
|
||||
#### Follow the steps below to deploy ToolJet on DigitalOcean:
|
||||
#### Follow the Steps Below to Deploy ToolJet on DigitalOcean:
|
||||
|
||||
1. Click on the button below to start one click deployment
|
||||
|
||||
|
|
@ -89,8 +87,8 @@ ToolJet server and client can be deployed as standalone applications. If you do
|
|||
|
||||
## Deploying ToolJet Database
|
||||
|
||||
If you intend to use this feature, you'd have to set up and deploy PostgREST server which helps querying ToolJet Database.
|
||||
You can learn more about this feature [here](/docs/tooljet-database).
|
||||
To use ToolJet Database, you'd have to set up and deploy PostgREST server which helps querying ToolJet Database.
|
||||
You can learn more about this feature [here](../tooljet-db/tooljet-database).
|
||||
|
||||
Follow the steps below to deploy ToolJet Database on DigitalOcean:
|
||||
|
||||
|
|
@ -110,7 +108,7 @@ Follow the steps below to deploy ToolJet Database on DigitalOcean:
|
|||
|
||||
## Upgrading to the Latest LTS Version
|
||||
|
||||
New LTS versions are released every 3-5 months with an end-of-life of atleast 18 months. To check the latest LTS version, visit the [ToolJet Docker Hub](https://hub.docker.com/r/tooljet/tooljet/tags) page. The LTS tags follow a naming convention with the prefix `LTS-` followed by the version number, for example `tooljet/tooljet:EE-LTS-latest`.
|
||||
New LTS versions are released every 3-5 months with an end-of-life of atleast 18 months. To check the latest LTS version, visit the [ToolJet Docker Hub](https://hub.docker.com/r/tooljet/tooljet/tags) page. The LTS tags follow a naming convention with the prefix `LTS-` followed by the version number, for example `tooljet/tooljet:ee-lts-latest`.
|
||||
|
||||
If this is a new installation of the application, you may start directly with the latest version. This guide is not required for new installations.
|
||||
|
||||
|
|
@ -120,4 +118,4 @@ If this is a new installation of the application, you may start directly with th
|
|||
|
||||
- Users on versions earlier than **v2.23.0-ee2.10.2** must first upgrade to this version before proceeding to the LTS version.
|
||||
|
||||
For specific issues or questions, refer to our **[Slack](https://tooljet.slack.com/join/shared_invite/zt-25438diev-mJ6LIZpJevG0LXCEcL0NhQ#)**.
|
||||
If you have any questions feel free to join our [Slack Community](https://tooljet.com/slack) or send us an email at hello@tooljet.com.
|
||||
|
|
|
|||
|
|
@ -154,7 +154,7 @@ curl -LO https://tooljet-deployments.s3.us-west-1.amazonaws.com/docker/backup-re
|
|||
|
||||
## Upgrading to the Latest LTS Version
|
||||
|
||||
New LTS versions are released every 3-5 months with an end-of-life of atleast 18 months. To check the latest LTS version, visit the [ToolJet Docker Hub](https://hub.docker.com/r/tooljet/tooljet/tags) page. The LTS tags follow a naming convention with the prefix `LTS-` followed by the version number, for example `tooljet/tooljet:EE-LTS-latest`.
|
||||
New LTS versions are released every 3-5 months with an end-of-life of atleast 18 months. To check the latest LTS version, visit the [ToolJet Docker Hub](https://hub.docker.com/r/tooljet/tooljet/tags) page. The LTS tags follow a naming convention with the prefix `LTS-` followed by the version number, for example `tooljet/tooljet:ee-lts-latest`.
|
||||
|
||||
If this is a new installation of the application, you may start directly with the latest version. This guide is not required for new installations.
|
||||
|
||||
|
|
|
|||
|
|
@ -9,8 +9,6 @@ title: AWS EC2
|
|||
You should setup a PostgreSQL database manually to be used by the ToolJet server.
|
||||
:::
|
||||
|
||||
*If you have any questions feel free to join our [Slack Community](https://tooljet.com/slack) or send us an email at hello@tooljet.com.*
|
||||
|
||||
You can effortlessly deploy Amazon Elastic Compute Cloud Service (EC2) by utilizing a **CloudFormation template**. This template will deploy all the services required to run ToolJet on AWS EC2 instances.
|
||||
|
||||
To deploy all the services at once, simply employ the following template:
|
||||
|
|
@ -21,15 +19,10 @@ curl -LO https://tooljet-deployments.s3.us-west-1.amazonaws.com/cloudformation/E
|
|||
Follow the steps below to deploy ToolJet on AWS EC2 instances.
|
||||
|
||||
1. Setup a PostgreSQL database and make sure that the database is accessible from the EC2 instance.
|
||||
|
||||
2. Login to your AWS management console and go to the EC2 management page.
|
||||
|
||||
3. Under the `Images` section, click on the `AMIs` button.
|
||||
|
||||
3. Under the **Images** section, click on the **AMIs** button.
|
||||
4. Find the [ToolJet version](https://github.com/ToolJet/ToolJet/releases) you want to deploy. Now, from the AMI search page, select the search type as "Public Images" and input the version you'd want `AMI Name : tooljet_vX.X.X.ubuntu_bionic` in the search bar.
|
||||
|
||||
5. Select ToolJet's AMI and bootup an EC2 instance.
|
||||
|
||||
5. Select ToolJet's AMI and bootup an EC2 instance. <br/>
|
||||
Creating a new security group is recommended. For example, if the installation should receive traffic from the internet, the inbound rules of the security group should look like this:
|
||||
|
||||
protocol| port | allowed_cidr|
|
||||
|
|
@ -39,19 +32,22 @@ Follow the steps below to deploy ToolJet on AWS EC2 instances.
|
|||
tcp | 443 | 0.0.0.0/0 |
|
||||
|
||||
|
||||
6. Once the instance boots up, SSH into the instance by running `ssh -i <path_to_pem_file> ubuntu@<public_ip_of_the_instance>`
|
||||
6. Once the instance boots up, SSH into the instance by running `ssh -i <path_to_pem_file> ubuntu@<public_ip_of_the_instance>`.
|
||||
|
||||
7. Switch to the app directory by running `cd ~/app`. Modify the contents of the `.env` file. ( Eg: `vim .env` )
|
||||
7. Switch to the app directory by running `cd ~/app`. <br/> Modify the contents of the `.env` file. ( Eg: `vim .env` )
|
||||
|
||||
The default `.env` file looks like this:
|
||||
```bash
|
||||
TOOLJET_HOST=http://<example>
|
||||
LOCKBOX_MASTER_KEY=<example>
|
||||
SECRET_KEY_BASE=<example>
|
||||
PG_DB=tooljet_prod
|
||||
PG_USER=<pg user name>
|
||||
PG_HOST=<pg host>
|
||||
PG_PASS=<pg user password>
|
||||
LOCKBOX_MASTER_KEY=
|
||||
SECRET_KEY_BASE=
|
||||
PG_DB=
|
||||
PG_USER=
|
||||
PG_HOST=
|
||||
PG_PASS=
|
||||
TOOLJET_DB=
|
||||
TOOLJET_DB_HOST=
|
||||
TOOLJET_DB_USER=
|
||||
TOOLJET_DB_PASS=
|
||||
```
|
||||
Read **[environment variables reference](/docs/setup/env-vars)**
|
||||
|
||||
|
|
@ -59,36 +55,34 @@ Follow the steps below to deploy ToolJet on AWS EC2 instances.
|
|||
If there are self signed HTTPS endpoints that ToolJet needs to connect to, please make sure that `NODE_EXTRA_CA_CERTS` environment variable is set to the absolute path containing the certificates.
|
||||
:::
|
||||
|
||||
8. `TOOLJET_HOST` environment variable determines where you can access the ToolJet client. It can either be the public ipv4 address of your instance or a custom domain that you want to use.
|
||||
8. `TOOLJET_DB_HOST` environment variable determines where you can access the ToolJet client. It can either be the public ipv4 address of your instance or a custom domain that you want to use.
|
||||
|
||||
Examples:
|
||||
`TOOLJET_HOST=http://12.34.56.78` or
|
||||
`TOOLJET_HOST=https://yourdomain.com` or
|
||||
`TOOLJET_HOST=https://tooljet.yourdomain.com`
|
||||
`TOOLJET_DB_HOST=http://12.34.56.78` or
|
||||
`TOOLJET_DB_HOST=https://yourdomain.com` or
|
||||
`TOOLJET_DB_HOST=https://tooljet.yourdomain.com`
|
||||
|
||||
:::info
|
||||
We use a [lets encrypt](https://letsencrypt.org/) plugin on top of nginx to create TLS certificates on the fly.
|
||||
:::
|
||||
|
||||
:::info
|
||||
Please make sure that `TOOLJET_HOST` starts with either `http://` or `https://`
|
||||
Please make sure that `TOOLJET_DB_HOST` starts with either `http://` or `https://`
|
||||
:::
|
||||
|
||||
9. Once you've configured the `.env` file, run `./setup_app`. This script will install all the dependencies of ToolJet and then will start the required services.
|
||||
|
||||
10. If you've set a custom domain for `TOOLJET_HOST`, add a `A record` entry in your DNS settings to point to the IP address of the EC2 instance.
|
||||
|
||||
12. You're all done, ToolJet client would now be served at the value you've set in `TOOLJET_HOST`.
|
||||
|
||||
#### Deploying ToolJet Database
|
||||
|
||||
ToolJet AMI comes inbuilt with PostgREST. If you intend to use this feature, you'd only have to setup the environment variables in `~/app/.env` file and run `./setup_app` script.
|
||||
|
||||
You can learn more about this feature [here](/docs/tooljet-database).
|
||||
You can learn more about this feature [here](../tooljet-db/tooljet-database).
|
||||
|
||||
## Upgrading to the Latest LTS Version
|
||||
|
||||
New LTS versions are released every 3-5 months with an end-of-life of atleast 18 months. To check the latest LTS version, visit the [ToolJet Docker Hub](https://hub.docker.com/r/tooljet/tooljet/tags) page. The LTS tags follow a naming convention with the prefix `LTS-` followed by the version number, for example `tooljet/tooljet:EE-LTS-latest`.
|
||||
New LTS versions are released every 3-5 months with an end-of-life of atleast 18 months. To check the latest LTS version, visit the [ToolJet Docker Hub](https://hub.docker.com/r/tooljet/tooljet/tags) page. The LTS tags follow a naming convention with the prefix `LTS-` followed by the version number, for example `tooljet/tooljet:ee-lts-latest`.
|
||||
|
||||
If this is a new installation of the application, you may start directly with the latest version. This guide is not required for new installations.
|
||||
|
||||
|
|
@ -98,10 +92,4 @@ If this is a new installation of the application, you may start directly with th
|
|||
|
||||
- Users on versions earlier than **v2.23.0-ee2.10.2** must first upgrade to this version before proceeding to the LTS version.
|
||||
|
||||
For specific issues or questions, refer to our **[Slack](https://tooljet.slack.com/join/shared_invite/zt-25438diev-mJ6LIZpJevG0LXCEcL0NhQ#)**.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
*If you have any questions feel free to join our [Slack Community](https://tooljet.com/slack) or send us an email at hello@tooljet.com.*
|
||||
|
|
|
|||
|
|
@ -23,6 +23,8 @@ If you already have existing services and wish to integrate ToolJet seamlessly i
|
|||
curl -LO https://tooljet-deployments.s3.us-west-1.amazonaws.com/cloudformation/Cloudformation-deploy.yml
|
||||
```
|
||||
|
||||
<div style={{paddingTop:'24px'}}>
|
||||
|
||||
## Redis
|
||||
|
||||
:::info
|
||||
|
|
@ -34,144 +36,97 @@ To deploy Redis on an ECS cluster, please follow the steps outlined below.
|
|||
Please note that if you already have an existing Redis setup, you can continue using it. However, if you need to create a new Redis service, you can follow the steps provided below.
|
||||
|
||||
- Create a new take definition
|
||||
|
||||
<div style={{textAlign: 'center'}}>
|
||||
|
||||
<img className="screenshot-full" src="/img/setup/ecs/ecs-1.png" alt="ECS Setup" />
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
- Please add container and image tag as shown below:
|
||||
|
||||
- Please add container and image tag as shown below: <br/>
|
||||
**Make sure that you are using redis version 6.x.x**
|
||||
|
||||
<div style={{textAlign: 'center'}}>
|
||||
|
||||
<img className="screenshot-full" src="/img/setup/ecs/ecs-2.png" alt="ECS Setup" />
|
||||
|
||||
</div>
|
||||
|
||||
- Ensure that when creating a service, Redis is integrated into the same cluster where your ToolJet app will be deployed.
|
||||
|
||||
- Ensure that when creating a service, Redis is integrated into the same cluster where your ToolJet app will be deployed. <br/>
|
||||
**Note: Please enable public IP**
|
||||
|
||||
<div style={{textAlign: 'center'}}>
|
||||
|
||||
<img className="screenshot-full" src="/img/setup/ecs/ecs-3.png" alt="ECS Setup" />
|
||||
|
||||
</div>
|
||||
</div>
|
||||
|
||||
<div style={{paddingTop:'24px'}}>
|
||||
|
||||
## ToolJet
|
||||
|
||||
Follow the steps below to deploy ToolJet on a ECS cluster.
|
||||
|
||||
1. Setup a PostgreSQL database ToolJet uses a postgres database as the persistent storage for storing data related to users and apps.
|
||||
1. Setup a PostgreSQL database, ToolJet uses a postgres database as the persistent storage for storing data related to users and apps.
|
||||
2. Create a target group and an application load balancer to route traffic onto ToolJet containers. You can [reference](https://docs.aws.amazon.com/AmazonECS/latest/userguide/create-application-load-balancer.html) AWS docs to set it up. Please note that ToolJet server exposes `/api/health`, which you can configure for health checks.
|
||||
|
||||
3. Create task definition for deploying ToolJet app as a service on your preconfigured cluster.
|
||||
1. Select Fargate as launch type compatibility
|
||||
2. Configure IAM roles and set operating system family as Linux.
|
||||
3. Select task size to have 3GB of memory and 1vCpu
|
||||
<img className="screenshot-full" src="/img/setup/ecs/ecs-4.png" alt="ECS Setup" />
|
||||
4. Add container details that is shown: <br/>
|
||||
Specify your container name ex: `ToolJet` <br/>
|
||||
Set the image you intend to deploy. ex: `tooljet/tooljet:ee-lts-latest` <br/>
|
||||
Update port mappings at container port `3000` for tcp protocol.
|
||||
<img className="screenshot-full" src="/img/setup/ecs/ecs-5.png" alt="ECS Setup" />
|
||||
|
||||
i. Select Fargate as launch type compatibility
|
||||
|
||||
ii. Configure IAM roles and set operating system family as Linux.
|
||||
|
||||
iii. Select task size to have 3GB of memory and 1vCpu
|
||||
Specify environmental values for the container. You'd want to make use of secrets to store sensitive information or credentials, kindly refer the AWS [docs](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data-secrets.html) to set it up. You can also store the env in S3 bucket, kindly refer the AWS [docs](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/taskdef-envfiles.html) .
|
||||
<img className="screenshot-full" src="/img/setup/ecs/ecs-6.png" alt="ECS Setup" />
|
||||
|
||||
<div style={{textAlign: 'center'}}>
|
||||
:::info
|
||||
For the setup, ToolJet requires:
|
||||
<ul>
|
||||
- **TOOLJET_DB**
|
||||
- **TOOLJET_DB_HOST**
|
||||
- **TOOLJET_DB_USER**
|
||||
- **TOOLJET_DB_PASS**
|
||||
- **PG_HOST**
|
||||
- **PG_DB**
|
||||
- **PG_USER**
|
||||
- **PG_PASS**
|
||||
- **SECRET_KEY_BASE**
|
||||
- **LOCKBOX_KEY**
|
||||
</ul>
|
||||
<br/>
|
||||
Read **[environment variables reference](./env-vars)**
|
||||
:::
|
||||
|
||||
<img className="screenshot-full" src="/img/setup/ecs/ecs-4.png" alt="ECS Setup" />
|
||||
|
||||
</div>
|
||||
|
||||
iv. Add container details that is shown:
|
||||
|
||||
Specify your container name ex: `ToolJet`
|
||||
|
||||
Set the image you intend to deploy. ex: `tooljet/tooljet:EE-LTS-latest`
|
||||
|
||||
Update port mappings at container port `3000` for tcp protocol.
|
||||
|
||||
<div style={{textAlign: 'center'}}>
|
||||
|
||||
<img className="screenshot-full" src="/img/setup/ecs/ecs-5.png" alt="ECS Setup" />
|
||||
|
||||
</div>
|
||||
|
||||
Specify environmental values for the container. You'd want to make use of secrets to store sensitive information or credentials, kindly refer the AWS [docs](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/specifying-sensitive-data-secrets.html) to set it up. You can also store the env in S3 bucket, kindly refer the AWS [docs](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/taskdef-envfiles.html) .
|
||||
|
||||
<div style={{textAlign: 'center'}}>
|
||||
|
||||
<img className="screenshot-full" src="/img/setup/ecs/ecs-6.png" alt="ECS Setup" />
|
||||
|
||||
</div>
|
||||
|
||||
:::info
|
||||
For the minimal setup, ToolJet requires: `TOOLJET_HOST`, `PG_HOST`, `PG_DB`, `PG_USER`, `PG_PASSWORD`, `SECRET_KEY_BASE` & `LOCKBOX_MASTER_KEY` keys in the secret.
|
||||
|
||||
Read **[environment variables reference](https://docs.tooljet.com/docs/setup/env-vars)**
|
||||
:::
|
||||
|
||||
Additionally, include the Redis environment variables within the ToolJet container mentioned above if you have followed the previous steps to create Redis.
|
||||
|
||||
```
|
||||
REDIS_HOST=<public ip of redis task>
|
||||
REDIS_PORT=6379
|
||||
REDIS_USER=default
|
||||
REDIS_PASSWORD=
|
||||
```
|
||||
|
||||
v. Make sure `Use log collection checked` and `Docker configuration` with the command `npm run start:dev`
|
||||
|
||||
<div style={{textAlign: 'center'}}>
|
||||
|
||||
<img className="screenshot-full" src="/img/setup/ecs/ecs-8.png" alt="ECS Setup" />
|
||||
|
||||
</div>
|
||||
Additionally, include the Redis environment variables within the ToolJet container mentioned above if you have followed the previous steps to create Redis.
|
||||
```
|
||||
REDIS_HOST=<public ip of redis task>
|
||||
REDIS_PORT=6379
|
||||
REDIS_USER=default
|
||||
REDIS_PASSWORD=
|
||||
```
|
||||
5. Make sure `Use log collection checked` and `Docker configuration` with the command `npm run start:dev`
|
||||
<img className="screenshot-full" src="/img/setup/ecs/ecs-8.png" alt="ECS Setup" />
|
||||
|
||||
4. Create a service to run your task definition within your cluster.
|
||||
|
||||
- Select the cluster which you have created
|
||||
|
||||
- Select launch type as Fargate
|
||||
|
||||
<div style={{textAlign: 'center'}}>
|
||||
|
||||
<img className="screenshot-full" src="/img/setup/ecs/ecs-9.png" alt="ECS Setup" />
|
||||
|
||||
</div>
|
||||
|
||||
<img className="screenshot-full" src="/img/setup/ecs/ecs-9.png" alt="ECS Setup" />
|
||||
- Select the cluster and set the service name
|
||||
|
||||
- You can set the number of tasks to start with as two
|
||||
|
||||
- Rest of the values can be kept as default
|
||||
|
||||
<div style={{textAlign: 'center'}}>
|
||||
|
||||
<img className="screenshot-full" src="/img/setup/ecs/ecs-10.png" alt="ECS Setup" />
|
||||
|
||||
</div>
|
||||
|
||||
<img className="screenshot-full" src="/img/setup/ecs/ecs-10.png" alt="ECS Setup" />
|
||||
- Click on next step to configure networking options
|
||||
|
||||
- Select your designated VPC, Subnets and Security groups. Kindly ensure that the security group allows for inbound traffic to http port 3000 for the task.
|
||||
|
||||
<div style={{textAlign: 'center'}}>
|
||||
|
||||
<img className="screenshot-full" src="/img/setup/ecs/ecs-11.png" alt="ECS Setup" />
|
||||
|
||||
</div>
|
||||
|
||||
<img className="screenshot-full" src="/img/setup/ecs/ecs-11.png" alt="ECS Setup" />
|
||||
- Since migrations are run as a part of container boot, please specify health check grace period for 900 seconds. Select the application loadbalancer option and set the target group name to the one we had created earlier. This will auto populate the health check endpoints.
|
||||
|
||||
:::info
|
||||
The setup above is just a template. Feel free to update the task definition and configure parameters for resources and environment variables according to your needs.
|
||||
:::
|
||||
|
||||
</div>
|
||||
|
||||
<div style={{paddingTop:'24px'}}>
|
||||
|
||||
## ToolJet Database
|
||||
|
||||
If you intend to use this feature, you'd have to set up and deploy PostgREST server which helps querying ToolJet Database. You can learn more about this feature [here](https://docs.tooljet.com/docs/tooljet-database).
|
||||
To use ToolJet Database, you'd have to set up and deploy PostgREST server which helps querying ToolJet Database. You can learn more about this feature [here](../tooljet-db/tooljet-database).
|
||||
|
||||
Deploying ToolJet Database is mandatory from ToolJet 3.0 or else the migration might break, checkout the following docs to know more about new major version, including breaking changes that require you to adjust your applications accordingly:
|
||||
- [Self Hosted](./upgrade-to-v3.md)
|
||||
- [Cloud](./cloud-v3-migration.md)
|
||||
|
||||
Follow the steps below to deploy PostgREST on a ECS cluster.
|
||||
|
||||
|
|
@ -225,11 +180,13 @@ Follow the steps below to deploy PostgREST on a ECS cluster.
|
|||
|
||||
</div>
|
||||
|
||||
Update ToolJet deployment with the appropriate env variables [here](https://docs.tooljet.com/docs/setup/env-vars/#enable-tooljet-database--optional-) and apply the changes.
|
||||
Update ToolJet deployment with the appropriate env variables [here](./env-vars/#enable-tooljet-database-required) and apply the changes.
|
||||
|
||||
</div>
|
||||
|
||||
## Upgrading to the Latest LTS Version
|
||||
|
||||
New LTS versions are released every 3-5 months with an end-of-life of atleast 18 months. To check the latest LTS version, visit the [ToolJet Docker Hub](https://hub.docker.com/r/tooljet/tooljet/tags) page. The LTS tags follow a naming convention with the prefix `LTS-` followed by the version number, for example `tooljet/tooljet:EE-LTS-latest`.
|
||||
New LTS versions are released every 3-5 months with an end-of-life of atleast 18 months. To check the latest LTS version, visit the [ToolJet Docker Hub](https://hub.docker.com/r/tooljet/tooljet/tags) page. The LTS tags follow a naming convention with the prefix `LTS-` followed by the version number, for example `tooljet/tooljet:ee-lts-latest`.
|
||||
|
||||
If this is a new installation of the application, you may start directly with the latest version. This guide is not required for new installations.
|
||||
|
||||
|
|
@ -239,5 +196,4 @@ If this is a new installation of the application, you may start directly with th
|
|||
|
||||
- Users on versions earlier than **v2.23.0-ee2.10.2** must first upgrade to this version before proceeding to the LTS version.
|
||||
|
||||
For specific issues or questions, refer to our **[Slack](https://tooljet.slack.com/join/shared_invite/zt-25438diev-mJ6LIZpJevG0LXCEcL0NhQ#)**.
|
||||
|
||||
*If you have any questions feel free to join our [Slack Community](https://tooljet.com/slack) or send us an email at hello@tooljet.com.*
|
||||
|
|
|
|||
|
|
@ -92,11 +92,10 @@ Use this environment variable to enable/disable the developement mode that allow
|
|||
| ---------------- | ----------------------------------------------- |
|
||||
| USER_SESSION_EXPIRY | This variable controls the user session expiry time. By default, the session expires after **10** days. The variable expects the value in minutes. ex: USER_SESSION_EXPIRY = 120 which is 2 hours |
|
||||
|
||||
### Enable ToolJet Database ( optional )
|
||||
### Enable ToolJet Database (required)
|
||||
|
||||
| variable | description |
|
||||
| -----------------------------| -------------------------------------------- |
|
||||
| ENABLE_TOOLJET_DB | `true` or `false` |
|
||||
| TOOLJET_DB | Default value is `tooljet_db` |
|
||||
| TOOLJET_DB_HOST | database host |
|
||||
| TOOLJET_DB_USER | database username |
|
||||
|
|
@ -104,8 +103,7 @@ Use this environment variable to enable/disable the developement mode that allow
|
|||
| TOOLJET_DB_PORT | database port |
|
||||
| PGRST_JWT_SECRET | JWT token client provided for authentication |
|
||||
| PGRST_HOST | postgrest database host |
|
||||
| TOOLJET_DB_RECONFIG | `true` or `false` |
|
||||
| TOOLJET_DB_STATEMENT_TIMEOUT | statement timeout in milliseconds |
|
||||
| PGRST_DB_PRE_CONFIG | postgrest.pre_config |
|
||||
|
||||
Use `ENABLE_TOOLJET_DB` to enable/disable the feature that allows users to work with inbuilt data store to build apps with. In order to set it up, [follow the instructions here](/docs/tooljet-db/tooljet-database/#enabling-the-tooljet-database-for-your-instance).
|
||||
|
||||
|
|
@ -296,13 +294,14 @@ This can be an absolute path, or relative to main HTML file.
|
|||
By default the client build will be done to be served with ToolJet server.
|
||||
If you intend to use client separately then can set `SERVE_CLIENT` to `false`.
|
||||
|
||||
## PostgREST server (Optional)
|
||||
## PostgREST server (required)
|
||||
|
||||
| variable | description |
|
||||
| ---------------- | ----------------------------------------------- |
|
||||
| PGRST_JWT_SECRET | JWT token client provided for authentication |
|
||||
| PGRST_DB_URI | database connection string for tooljet database |
|
||||
| PGRST_LOG_LEVEL | `info` |
|
||||
| PGRST_DB_PRE_CONFIG | postgrest.pre_config |
|
||||
|
||||
If you intent to make changes in the above configuration. Please refer [PostgREST configuration docs](https://postgrest.org/en/stable/configuration.html#environment-variables).
|
||||
|
||||
|
|
|
|||
|
|
@ -9,11 +9,8 @@ title: Google Cloud Run
|
|||
You should setup a PostgreSQL database manually to be used by ToolJet.
|
||||
:::
|
||||
|
||||
*If you have any questions feel free to join our [Slack Community](https://tooljet.com/slack) or send us an email at hello@tooljet.com.*
|
||||
|
||||
Follow the steps below to deploy ToolJet on Cloud run with `gcloud` CLI.
|
||||
|
||||
|
||||
## Deploying ToolJet application
|
||||
1. Create a new Google Cloud Run Service:
|
||||
|
||||
|
|
@ -72,79 +69,46 @@ Click on deploy once the above parameters are set.
|
|||
Once the Service is created and live, to make the Cloud Service URL public. Please follow the steps [**here**](https://cloud.google.com/run/docs/securing/managing-access) to make the service public.
|
||||
:::
|
||||
|
||||
### Deploying ToolJet Database
|
||||
## Deploying ToolJet Database
|
||||
|
||||
If you intend to use this feature, you'd have to set up and deploy PostgREST server which helps querying ToolJet Database.
|
||||
|
||||
#### PostgREST server
|
||||
To use ToolJet Database, you'd have to set up and deploy PostgREST server which helps querying ToolJet Database. Deploying ToolJet Database is mandatory from ToolJet 3.0 or else the migration might break, checkout the following docs to know more about new major version, including breaking changes that require you to adjust your applications accordingly:
|
||||
- [Self Hosted](./upgrade-to-v3.md)
|
||||
|
||||
1. Cloud Run requires prebuilt image to be present within cloud registry. You can pull specific PostgREST image from docker hub and then tag with your project to push it to cloud registry.
|
||||
```bash
|
||||
docker pull postgrest/postgrest:v12.0.2
|
||||
```
|
||||
|
||||
```bash
|
||||
gcloud auth configure-docker
|
||||
docker pull postgrest/postgrest:v10.1.1.20221215
|
||||
docker tag postgrest/postgrest:v10.1.1.20221215 gcr.io/tooljet-test-338806/postgrest/postgrest:v10.1.1.20221215
|
||||
docker push gcr.io/tooljet-test-338806/postgrest/postgrest:v10.1.1.20221215
|
||||
```
|
||||
Please run the above command by launching googleCLI which will help to push the PostgREST image to Google container registry.
|
||||
|
||||
2. Ingress and Authentication can be set as shown below, to begin with. Feel free to change the security configurations as per you see fit.
|
||||
|
||||
<img className="screenshot-full" src="/img/cloud-run/ingress-auth.png" alt="ingress-auth" />
|
||||
|
||||
|
||||
3. Under containers tab, please make sure the port is set 3000 and CPU capacity is set to 1GiB.
|
||||
|
||||
<img className="screenshot-full" src="/img/cloud-run/port-and-capacity-postgrest.png" alt="port-and-capacity-postgrest" />
|
||||
|
||||
Please run the above command by launching googleCLI which will help to push the PostgREST image to Google container registry.
|
||||
4. Under environmental variable please add corresponding ToolJet database env variables. You can also refer [env variable](./env-vars/#enable-tooljet-database-required).
|
||||
|
||||
<div style={{textAlign: 'center'}}>
|
||||
<img className="screenshot-full" src="/img/cloud-run/CLI.png" alt="CLI" />
|
||||
</div>
|
||||
5. Please go to connection tab. Under Cloud SQL instance please select the PostgreSQL database which you have set-up for ToolJet application or the separate PostgreSQL database created respective to ToolJet Database from the drop-down option.
|
||||
|
||||
<img className="screenshot-full" src="/img/cloud-run/Cloud-SQL-instance.png" alt="Cloud-SQL-instance" />
|
||||
|
||||
2. Once the PostgREST image is pushed. Click on create service.
|
||||
Click on deploy once the above parameters are set.
|
||||
|
||||
Select and add the pushed PostgREST image as shown in below.
|
||||
:::info
|
||||
Once the Service is created and live, to make the Cloud Service URL public. Please follow the steps [**here**](https://cloud.google.com/run/docs/securing/managing-access) to make the service public.
|
||||
:::
|
||||
|
||||
<div style={{textAlign: 'center'}}>
|
||||
<img className="screenshot-full" src="/img/cloud-run/create-service-cloud-run-postgrest.png" alt="create-service-cloud-run-postgrest" />
|
||||
</div>
|
||||
|
||||
|
||||
3. Ingress and Authentication can be set as shown below, to begin with. Feel free to change the security configurations as per you see fit.
|
||||
|
||||
<div style={{textAlign: 'center'}}>
|
||||
<img className="screenshot-full" src="/img/cloud-run/ingress-auth.png" alt="ingress-auth" />
|
||||
</div>
|
||||
|
||||
|
||||
4. Under containers tab, please make sure the port is set 3000 and CPU capacity is set to 1GiB.
|
||||
|
||||
<div style={{textAlign: 'center'}}>
|
||||
<img className="screenshot-full" src="/img/cloud-run/port-and-capacity-postgrest.png" alt="port-and-capacity-postgrest" />
|
||||
</div>
|
||||
|
||||
5. Under environmental variable please add corresponding ToolJet database env variables. You can also refer [env variable](/docs/setup/env-vars/#enable-tooljet-database--optional-).
|
||||
|
||||
6. Please go to connection tab. Under Cloud SQL instance please select the PostgreSQL database which you have set-up for ToolJet application or the separate PostgreSQL database created respective to ToolJet Database from the drop-down option.
|
||||
|
||||
|
||||
<div style={{textAlign: 'center'}}>
|
||||
<img className="screenshot-full" src="/img/cloud-run/Cloud-SQL-instance.png" alt="Cloud-SQL-instance" />
|
||||
</div>
|
||||
|
||||
|
||||
Click on deploy once the above parameters are set.
|
||||
|
||||
:::info
|
||||
Once the Service is created and live, to make the Cloud Service URL public. Please follow the steps [**here**](https://cloud.google.com/run/docs/securing/managing-access) to make the service public.
|
||||
:::
|
||||
|
||||
|
||||
|
||||
7. Additional Environmental variable to be added to ToolJet application or ToolJet Server connect to PostgREST server. You can also refer env variable [**here**](/docs/setup/env-vars/#enable-tooljet-database--optional-)
|
||||
|
||||
|
||||
<div style={{textAlign: 'center'}}>
|
||||
<img className="screenshot-full" src="/img/cloud-run/env-for-tooljet.png" alt="env-for-tooljet" />
|
||||
</div>
|
||||
6. Additional Environmental variable to be added to ToolJet application or ToolJet Server connect to PostgREST server. You can also refer env variable [**here**](./env-vars/#enable-tooljet-database-required)
|
||||
|
||||
<img className="screenshot-full" src="/img/cloud-run/env-for-tooljet.png" alt="env-for-tooljet" />
|
||||
|
||||
## Upgrading to the Latest LTS Version
|
||||
|
||||
New LTS versions are released every 3-5 months with an end-of-life of atleast 18 months. To check the latest LTS version, visit the [ToolJet Docker Hub](https://hub.docker.com/r/tooljet/tooljet/tags) page. The LTS tags follow a naming convention with the prefix `LTS-` followed by the version number, for example `tooljet/tooljet:EE-LTS-latest`.
|
||||
New LTS versions are released every 3-5 months with an end-of-life of atleast 18 months. To check the latest LTS version, visit the [ToolJet Docker Hub](https://hub.docker.com/r/tooljet/tooljet/tags) page. The LTS tags follow a naming convention with the prefix `LTS-` followed by the version number, for example `tooljet/tooljet:ee-lts-latest`.
|
||||
|
||||
If this is a new installation of the application, you may start directly with the latest version. This guide is not required for new installations.
|
||||
|
||||
|
|
@ -154,4 +118,4 @@ If this is a new installation of the application, you may start directly with th
|
|||
|
||||
- Users on versions earlier than **v2.23.0-ee2.10.2** must first upgrade to this version before proceeding to the LTS version.
|
||||
|
||||
For specific issues or questions, refer to our **[Slack](https://tooljet.slack.com/join/shared_invite/zt-25438diev-mJ6LIZpJevG0LXCEcL0NhQ#)**.
|
||||
*If you have any questions feel free to join our [Slack Community](https://tooljet.com/slack) or send us an email at hello@tooljet.com.*
|
||||
|
|
|
|||
|
|
@ -7,8 +7,6 @@ title: Helm
|
|||
|
||||
This repository contains Helm charts for deploying [ToolJet](https://github.com/ToolJet/helm-charts) on a Kubernetes Cluster using Helm v3. The charts include an integrated PostgreSQL server that is enabled by default. However, you have the option to disable it and configure a different PostgreSQL server by updating the `values.yml` file.
|
||||
|
||||
*If you have any questions feel free to join our [Slack Community](https://tooljet.com/slack) or send us an email at hello@tooljet.com.*
|
||||
|
||||
## Installation
|
||||
|
||||
### From Helm repo
|
||||
|
|
@ -17,27 +15,25 @@ helm repo add tooljet https://github.com/ToolJet/helm-charts.git
|
|||
helm install tooljet tooljet/tooljet
|
||||
```
|
||||
|
||||
### From the source
|
||||
### From the Source
|
||||
1. Clone the repository and navigate to this directory
|
||||
2. Run `helm dependency update
|
||||
2. Run `helm dependency update`
|
||||
3. It is recommended but optional to modify the values in the `values.yaml` file, such as usernames, passwords, persistence settings, etc.
|
||||
4. Run `helm install -n $NAMESPACE --create-namespace $RELEASE .`
|
||||
|
||||
Remember to replace the variables with your specific configuration values.
|
||||
|
||||
**ToolJet Database**
|
||||
## ToolJet Database
|
||||
|
||||
ToolJet offers a hosted database solution that allows you to build applications quickly and manage your data effortlessly. The ToolJet database requires no setup and provides a user-friendly interface for data management.
|
||||
|
||||
For more information about the ToolJet database, you can visit [here](/docs/tooljet-database).
|
||||
For more information about the ToolJet database, you can visit [here](../tooljet-db/tooljet-database).
|
||||
|
||||
If you plan to use this feature, you need to set up and deploy the PostgREST server, which facilitates querying the ToolJet Database.
|
||||
|
||||
To enable the ToolJet database, please set the environment variable `ENABLE_TOOLJET_DB` to true in the `values.yaml` file.
|
||||
You need to set up and deploy the PostgREST server, which facilitates querying the ToolJet Database.
|
||||
|
||||
## Upgrading to the Latest LTS Version
|
||||
|
||||
New LTS versions are released every 3-5 months with an end-of-life of atleast 18 months. To check the latest LTS version, visit the [ToolJet Docker Hub](https://hub.docker.com/r/tooljet/tooljet/tags) page. The LTS tags follow a naming convention with the prefix `LTS-` followed by the version number, for example `tooljet/tooljet:EE-LTS-latest`.
|
||||
New LTS versions are released every 3-5 months with an end-of-life of atleast 18 months. To check the latest LTS version, visit the [ToolJet Docker Hub](https://hub.docker.com/r/tooljet/tooljet/tags) page. The LTS tags follow a naming convention with the prefix `LTS-` followed by the version number, for example `tooljet/tooljet:ee-lts-latest`.
|
||||
|
||||
If this is a new installation of the application, you may start directly with the latest version. This guide is not required for new installations.
|
||||
|
||||
|
|
@ -47,4 +43,4 @@ If this is a new installation of the application, you may start directly with th
|
|||
|
||||
- Users on versions earlier than **v2.23.0-ee2.10.2** must first upgrade to this version before proceeding to the LTS version.
|
||||
|
||||
For specific issues or questions, refer to our **[Slack](https://tooljet.slack.com/join/shared_invite/zt-25438diev-mJ6LIZpJevG0LXCEcL0NhQ#)**.
|
||||
*If you have any questions feel free to join our [Slack Community](https://tooljet.com/slack) or send us an email at hello@tooljet.com.*
|
||||
|
|
|
|||
|
|
@ -9,8 +9,6 @@ title: Kubernetes (AKS)
|
|||
You should setup a PostgreSQL database manually to be used by ToolJet. We recommend using Azure Database for PostgreSQL since this guide is for deploying using AKS.
|
||||
:::
|
||||
|
||||
*If you have any questions feel free to join our [Slack Community](https://tooljet.com/slack) or send us an email at hello@tooljet.com.*
|
||||
|
||||
Follow the steps below to deploy ToolJet on a AKS Kubernetes cluster.
|
||||
|
||||
1. Create an AKS cluster and connect to it to start with the deployment. You can follow the steps as mentioned on the [Azure's documentation](https://docs.microsoft.com/en-us/azure/aks/kubernetes-walkthrough-portal).
|
||||
|
|
@ -21,7 +19,25 @@ Follow the steps below to deploy ToolJet on a AKS Kubernetes cluster.
|
|||
curl -LO https://tooljet-deployments.s3.us-west-1.amazonaws.com/kubernetes/AKS/deployment.yaml
|
||||
```
|
||||
|
||||
Make sure to edit the environment variables in the `deployment.yaml`. We advise to use secrets to setup sensitive information. You can check out the available options [here](https://docs.tooljet.com/docs/setup/env-vars).
|
||||
Make sure to edit the environment variables in the `deployment.yaml`. We advise to use secrets to setup sensitive information. You can check out the available options [here](./env-vars).
|
||||
|
||||
:::info
|
||||
For the setup, ToolJet requires:
|
||||
<ul>
|
||||
- **TOOLJET_DB**
|
||||
- **TOOLJET_DB_HOST**
|
||||
- **TOOLJET_DB_USER**
|
||||
- **TOOLJET_DB_PASS**
|
||||
- **PG_HOST**
|
||||
- **PG_DB**
|
||||
- **PG_USER**
|
||||
- **PG_PASS**
|
||||
- **SECRET_KEY_BASE**
|
||||
- **LOCKBOX_KEY**
|
||||
</ul>
|
||||
<br/>
|
||||
Read **[environment variables reference](./env-vars)**
|
||||
:::
|
||||
|
||||
:::info
|
||||
If there are self signed HTTPS endpoints that Tooljet needs to connect to, please make sure that `NODE_EXTRA_CA_CERTS` environment variable is set to the absolute path containing the certificates. You can make use of kubernetes secrets to mount the certificate file onto the containers.
|
||||
|
|
@ -40,11 +56,9 @@ If there are self signed HTTPS endpoints that Tooljet needs to connect to, pleas
|
|||
|
||||
You will be able to access your ToolJet installation once the pods and services running.
|
||||
|
||||
|
||||
|
||||
## ToolJet Database
|
||||
|
||||
If you intend to use this feature, you'd have to set up and deploy PostgREST server which helps querying ToolJet Database. Please [follow the instructions here](/docs/setup/env-vars/#enable-tooljet-database--optional-) for additional environment variables configuration to be done.
|
||||
To use ToolJet Database, you'd have to set up and deploy PostgREST server which helps querying ToolJet Database. Please [follow the instructions here](./env-vars/#enable-tooljet-database-required).
|
||||
|
||||
1. Setup PostgREST server
|
||||
|
||||
|
|
@ -56,7 +70,7 @@ If you intend to use this feature, you'd have to set up and deploy PostgREST ser
|
|||
|
||||
## Upgrading to the Latest LTS Version
|
||||
|
||||
New LTS versions are released every 3-5 months with an end-of-life of atleast 18 months. To check the latest LTS version, visit the [ToolJet Docker Hub](https://hub.docker.com/r/tooljet/tooljet/tags) page. The LTS tags follow a naming convention with the prefix `LTS-` followed by the version number, for example `tooljet/tooljet:EE-LTS-latest`.
|
||||
New LTS versions are released every 3-5 months with an end-of-life of atleast 18 months. To check the latest LTS version, visit the [ToolJet Docker Hub](https://hub.docker.com/r/tooljet/tooljet/tags) page. The LTS tags follow a naming convention with the prefix `LTS-` followed by the version number, for example `tooljet/tooljet:ee-lts-latest`.
|
||||
|
||||
If this is a new installation of the application, you may start directly with the latest version. This guide is not required for new installations.
|
||||
|
||||
|
|
@ -66,4 +80,4 @@ If this is a new installation of the application, you may start directly with th
|
|||
|
||||
- Users on versions earlier than **v2.23.0-ee2.10.2** must first upgrade to this version before proceeding to the LTS version.
|
||||
|
||||
For specific issues or questions, refer to our **[Slack](https://tooljet.slack.com/join/shared_invite/zt-25438diev-mJ6LIZpJevG0LXCEcL0NhQ#)**.
|
||||
*If you have any questions feel free to join our [Slack Community](https://tooljet.com/slack) or send us an email at hello@tooljet.com.*
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ title: Kubernetes (EKS)
|
|||
Follow the steps below to deploy ToolJet on an EKS Kubernetes cluster.
|
||||
|
||||
:::info
|
||||
You should set up a PostgreSQL database manually to be used by ToolJet. We recommend using an RDS PostgreSQL database. You can find the system requirements [here](https://docs.tooljet.com/docs/setup/system-requirements#database-software)
|
||||
You should set up a PostgreSQL database manually to be used by ToolJet. We recommend using an RDS PostgreSQL database. You can find the system requirements [here](./system-requirements#database-software)
|
||||
:::
|
||||
|
||||
1. Create an EKS cluster and connect to it to start with the deployment. You can follow the steps as mentioned in the [AWS documentation](https://docs.aws.amazon.com/eks/latest/userguide/create-cluster.html).
|
||||
|
|
@ -19,7 +19,25 @@ _The file below is just a template and might not suit production environments. Y
|
|||
kubectl apply -f https://tooljet-deployments.s3.us-west-1.amazonaws.com/kubernetes/deployment.yaml
|
||||
```
|
||||
|
||||
Make sure to edit the environment variables in the `deployment.yaml`. We advise using secrets to set up sensitive information. You can check out the available options [here](https://docs.tooljet.com/docs/setup/env-vars).
|
||||
Make sure to edit the environment variables in the `deployment.yaml`. We advise using secrets to set up sensitive information. You can check out the available options [here](./env-vars).
|
||||
|
||||
:::info
|
||||
For the setup, ToolJet requires:
|
||||
<ul>
|
||||
- **TOOLJET_DB**
|
||||
- **TOOLJET_DB_HOST**
|
||||
- **TOOLJET_DB_USER**
|
||||
- **TOOLJET_DB_PASS**
|
||||
- **PG_HOST**
|
||||
- **PG_DB**
|
||||
- **PG_USER**
|
||||
- **PG_PASS**
|
||||
- **SECRET_KEY_BASE**
|
||||
- **LOCKBOX_KEY**
|
||||
</ul>
|
||||
<br/>
|
||||
Read **[environment variables reference](./env-vars)**
|
||||
:::
|
||||
|
||||
3. Create a Kubernetes service to publish the Kubernetes deployment that you have created. We have a [template](https://tooljet-deployments.s3.us-west-1.amazonaws.com/kubernetes/service.yaml) for exposing the ToolJet server as a service using an AWS Load Balancer.
|
||||
|
||||
|
|
@ -28,7 +46,7 @@ Make sure to edit the environment variables in the `deployment.yaml`. We advise
|
|||
|
||||
## ToolJet Database
|
||||
|
||||
If you intend to use this feature, you'd have to set up and deploy a PostgREST server, which helps in querying the ToolJet Database. Please [follow the instructions here](https://docs.tooljet.com/docs/setup/env-vars/#enable-tooljet-database--optional-) for additional environment variables configuration.
|
||||
To use ToolJet Database, you'd have to set up and deploy a PostgREST server, which helps in querying the ToolJet Database. Please [follow the instructions here](./env-vars/#enable-tooljet-database-required).
|
||||
|
||||
1. Set up PostgREST server
|
||||
|
||||
|
|
@ -40,7 +58,7 @@ Update ToolJet deployment with the appropriate env variables [here](https://tool
|
|||
|
||||
## Upgrading to the Latest LTS Version
|
||||
|
||||
New LTS versions are released every 3-5 months with an end-of-life of at least 18 months. To check the latest LTS version, visit the [ToolJet Docker Hub](https://hub.docker.com/r/tooljet/tooljet/tags) page. The LTS tags follow a naming convention with the prefix `LTS-` followed by the version number, for example `tooljet/tooljet:EE-LTS-latest`.
|
||||
New LTS versions are released every 3-5 months with an end-of-life of at least 18 months. To check the latest LTS version, visit the [ToolJet Docker Hub](https://hub.docker.com/r/tooljet/tooljet/tags) page. The LTS tags follow a naming convention with the prefix `LTS-` followed by the version number, for example `tooljet/tooljet:ee-lts-latest`.
|
||||
|
||||
If this is a new installation of the application, you may start directly with the latest version. This guide is not required for new installations.
|
||||
|
||||
|
|
@ -50,4 +68,4 @@ If this is a new installation of the application, you may start directly with th
|
|||
|
||||
- Users on versions earlier than **v2.23.0-ee2.10.2** must first upgrade to this version before proceeding to the LTS version.
|
||||
|
||||
For specific issues or questions, refer to our **[Slack](https://tooljet.slack.com/join/shared_invite/zt-25438diev-mJ6LIZpJevG0LXCEcL0NhQ#)**.
|
||||
*If you have any questions feel free to join our [Slack Community](https://tooljet.com/slack) or send us an email at hello@tooljet.com.*
|
||||
|
|
|
|||
|
|
@ -9,8 +9,6 @@ title: Kubernetes (GKE)
|
|||
You should setup a PostgreSQL database manually to be used by ToolJet. We recommend using Cloud SQL since this guide is for deploying using GKE.
|
||||
:::
|
||||
|
||||
*If you have any questions feel free to join our [Slack Community](https://tooljet.com/slack) or send us an email at hello@tooljet.com.*
|
||||
|
||||
Follow the steps below to deploy ToolJet on a GKE Kubernetes cluster.
|
||||
|
||||
1. Create an SSL certificate.
|
||||
|
|
@ -33,7 +31,24 @@ gcloud compute addresses create tj-static-ip --global
|
|||
curl -LO https://tooljet-deployments.s3.us-west-1.amazonaws.com/kubernetes/GKE/deployment.yaml
|
||||
```
|
||||
|
||||
Make sure to edit the environment variables in the `deployment.yaml`. You can check out the available options [here](https://docs.tooljet.com/docs/setup/env-vars).
|
||||
Make sure to edit the environment variables in the `deployment.yaml`. You can check out the available options [here](./env-vars).
|
||||
|
||||
:::info
|
||||
For the setup, ToolJet requires:
|
||||
<ul>
|
||||
- **TOOLJET_DB**
|
||||
- **TOOLJET_DB_HOST**
|
||||
- **TOOLJET_DB_USER**
|
||||
- **TOOLJET_DB_PASS**
|
||||
- **PG_HOST**
|
||||
- **PG_DB**
|
||||
- **PG_USER**
|
||||
- **PG_PASS**
|
||||
- **SECRET_KEY_BASE**
|
||||
- **LOCKBOX_KEY**
|
||||
</ul>
|
||||
Read **[environment variables reference](./env-vars)**
|
||||
:::
|
||||
|
||||
:::info
|
||||
If there are self signed HTTPS endpoints that Tooljet needs to connect to, please make sure that `NODE_EXTRA_CA_CERTS` environment variable is set to the absolute path containing the certificates. You can make use of kubernetes secrets to mount the certificate file onto the containers.
|
||||
|
|
@ -65,12 +80,9 @@ It might take a few minutes to provision the managed certificates. [Managed cert
|
|||
|
||||
You will be able to access your ToolJet installation once the pods, service and the ingress is running.
|
||||
|
||||
|
||||
|
||||
|
||||
## ToolJet Database
|
||||
|
||||
If you intend to use this feature, you'd have to set up and deploy PostgREST server which helps querying ToolJet Database. Please [follow the instructions here](/docs/setup/env-vars/#enable-tooljet-database--optional-) for additional environment variables configuration to be done.
|
||||
To use ToolJet Database, you'd have to set up and deploy PostgREST server which helps querying ToolJet Database. Please [follow the instructions here](./env-vars/#enable-tooljet-database-required).
|
||||
|
||||
1. Setup PostgREST server
|
||||
|
||||
|
|
@ -82,7 +94,7 @@ If you intend to use this feature, you'd have to set up and deploy PostgREST ser
|
|||
|
||||
## Upgrading to the Latest LTS Version
|
||||
|
||||
New LTS versions are released every 3-5 months with an end-of-life of atleast 18 months. To check the latest LTS version, visit the [ToolJet Docker Hub](https://hub.docker.com/r/tooljet/tooljet/tags) page. The LTS tags follow a naming convention with the prefix `LTS-` followed by the version number, for example `tooljet/tooljet:EE-LTS-latest`.
|
||||
New LTS versions are released every 3-5 months with an end-of-life of atleast 18 months. To check the latest LTS version, visit the [ToolJet Docker Hub](https://hub.docker.com/r/tooljet/tooljet/tags) page. The LTS tags follow a naming convention with the prefix `LTS-` followed by the version number, for example `tooljet/tooljet:ee-lts-latest`.
|
||||
|
||||
If this is a new installation of the application, you may start directly with the latest version. This guide is not required for new installations.
|
||||
|
||||
|
|
@ -92,4 +104,4 @@ If this is a new installation of the application, you may start directly with th
|
|||
|
||||
- Users on versions earlier than **v2.23.0-ee2.10.2** must first upgrade to this version before proceeding to the LTS version.
|
||||
|
||||
For specific issues or questions, refer to our **[Slack](https://tooljet.slack.com/join/shared_invite/zt-25438diev-mJ6LIZpJevG0LXCEcL0NhQ#)**.
|
||||
*If you have any questions feel free to join our [Slack Community](https://tooljet.com/slack) or send us an email at hello@tooljet.com.*
|
||||
|
|
|
|||
|
|
@ -9,17 +9,25 @@ title: Kubernetes
|
|||
You should setup a PostgreSQL database manually to be used by ToolJet.
|
||||
:::
|
||||
|
||||
*If you have any questions feel free to join our [Slack Community](https://tooljet.com/slack) or send us an email at hello@tooljet.com.*
|
||||
|
||||
Follow the steps below to deploy ToolJet on a Kubernetes cluster.
|
||||
|
||||
1. Setup a PostgreSQL database
|
||||
1. **Setup a PostgreSQL database** <br/>
|
||||
ToolJet uses a postgres database as the persistent storage for storing data related to users and apps. We do not have plans to support other databases such as MySQL.
|
||||
2. **Create a Kubernetes secret with name `server`.** <br/>
|
||||
For the setup, ToolJet requires:
|
||||
|
||||
- **TOOLJET_DB**
|
||||
- **TOOLJET_DB_HOST**
|
||||
- **TOOLJET_DB_USER**
|
||||
- **TOOLJET_DB_PASS**
|
||||
- **PG_HOST**
|
||||
- **PG_DB**
|
||||
- **PG_USER**
|
||||
- **PG_PASS**
|
||||
- **SECRET_KEY_BASE**
|
||||
- **LOCKBOX_KEY**
|
||||
|
||||
2. Create a Kubernetes secret with name `server`. For the minimal setup, ToolJet requires `pg_host`, `pg_db`, `pg_user`, `pg_password`, `secret_key_base` & `lockbox_key` keys in the secret.
|
||||
|
||||
Read **[environment variables reference](/docs/setup/env-vars)**
|
||||
|
||||
Read **[environment variables reference](./env-vars)**
|
||||
3. Create a Kubernetes deployment
|
||||
|
||||
```bash
|
||||
|
|
@ -48,24 +56,12 @@ If there are self signed HTTPS endpoints that ToolJet needs to connect to, pleas
|
|||
- [GKE Ingress for HTTP(S) Load Balancing](https://cloud.google.com/kubernetes-engine/docs/concepts/ingress)
|
||||
|
||||
:::tip
|
||||
If you want to serve ToolJet client from services such as Firebase or Netlify, please read the client Setup documentation **[here](/docs/setup/client)**.
|
||||
If you want to serve ToolJet client from services such as Firebase or Netlify, please read the client Setup documentation **[here](./client)**.
|
||||
:::
|
||||
|
||||
## ToolJet Database
|
||||
|
||||
If you intend to use this feature, you'd have to set up and deploy PostgREST server which helps querying ToolJet Database. Please [follow the instructions here](/docs/setup/env-vars/#enable-tooljet-database--optional-) for additional environment variables configuration to be done.
|
||||
|
||||
1. Setup PostgREST server
|
||||
|
||||
```bash
|
||||
kubectl apply -f https://raw.githubusercontent.com/ToolJet/ToolJet/main/deploy/kubernetes/postgrest.yaml
|
||||
```
|
||||
|
||||
2. Update ToolJet deployment with the appropriate env variables [here](https://tooljet-deployments.s3.us-west-1.amazonaws.com/kubernetes/deployment.yaml) and apply the changes.
|
||||
|
||||
## Upgrading to the Latest LTS Version
|
||||
|
||||
New LTS versions are released every 3-5 months with an end-of-life of atleast 18 months. To check the latest LTS version, visit the [ToolJet Docker Hub](https://hub.docker.com/r/tooljet/tooljet/tags) page. The LTS tags follow a naming convention with the prefix `LTS-` followed by the version number, for example `tooljet/tooljet:EE-LTS-latest`.
|
||||
New LTS versions are released every 3-5 months with an end-of-life of atleast 18 months. To check the latest LTS version, visit the [ToolJet Docker Hub](https://hub.docker.com/r/tooljet/tooljet/tags) page. The LTS tags follow a naming convention with the prefix `LTS-` followed by the version number, for example `tooljet/tooljet:ee-lts-latest`.
|
||||
|
||||
If this is a new installation of the application, you may start directly with the latest version. This guide is not required for new installations.
|
||||
|
||||
|
|
@ -75,4 +71,4 @@ If this is a new installation of the application, you may start directly with th
|
|||
|
||||
- Users on versions earlier than **v2.23.0-ee2.10.2** must first upgrade to this version before proceeding to the LTS version.
|
||||
|
||||
For specific issues or questions, refer to our **[Slack](https://tooljet.slack.com/join/shared_invite/zt-25438diev-mJ6LIZpJevG0LXCEcL0NhQ#)**.
|
||||
*If you have any questions feel free to join our [Slack Community](https://tooljet.com/slack) or send us an email at hello@tooljet.com.*
|
||||
|
|
|
|||
|
|
@ -9,15 +9,23 @@ title: Openshift
|
|||
You should setup a PostgreSQL database manually to be used by ToolJet.
|
||||
:::
|
||||
|
||||
*If you have any questions feel free to join our [Slack Community](https://tooljet.com/slack) or send us an email at hello@tooljet.com.*
|
||||
|
||||
Follow the steps below to deploy ToolJet on Openshift.
|
||||
|
||||
1. Setup a PostgreSQL database ToolJet uses a postgres database as the persistent storage for storing data related to users and apps. We do not have plans to support other databases such as MySQL.
|
||||
|
||||
2. Create a Kubernetes secret with name `server`. For the minimal setup, ToolJet requires `pg_host`, `pg_db`, `pg_user`, `pg_password`, `secret_key_base` & `lockbox_key` keys in the secret.
|
||||
2. Create a Kubernetes secret with name `server`. For the setup, ToolJet requires:
|
||||
- **TOOLJET_DB**
|
||||
- **TOOLJET_DB_HOST**
|
||||
- **TOOLJET_DB_USER**
|
||||
- **TOOLJET_DB_PASS**
|
||||
- **PG_HOST**
|
||||
- **PG_DB**
|
||||
- **PG_USER**
|
||||
- **PG_PASS**
|
||||
- **SECRET_KEY_BASE**
|
||||
- **LOCKBOX_KEY**
|
||||
|
||||
Read **[environment variables reference](https://docs.tooljet.com/docs/setup/env-vars)**
|
||||
Read **[environment variables reference](./env-vars)**
|
||||
|
||||
3. Once you have logged into the Openshift developer dashboard click on `+Add` tab. Select import YAML from the local machine.
|
||||
|
||||
|
|
@ -60,9 +68,9 @@ If there are self signed HTTPS endpoints that Tooljet needs to connect to, pleas
|
|||
|
||||
## ToolJet Database
|
||||
|
||||
You can know more about tooljet database [here](https://docs.tooljet.com/docs/tooljet-database)
|
||||
You can know more about tooljet database [here](../tooljet-db/tooljet-database)
|
||||
|
||||
If you intend to use this feature, you'd have to set up and deploy PostgREST server which helps querying ToolJet Database. Please [follow the instructions here](https://docs.tooljet.com/docs/setup/env-vars/#enable-tooljet-database--optional-) for additional environment variables configuration to be done.
|
||||
To use ToolJet Database, you'd have to set up and deploy PostgREST server which helps querying ToolJet Database. Please [follow the instructions here](./env-vars/#enable-tooljet-database-required).
|
||||
|
||||
```
|
||||
https://tooljet-deployments.s3.us-west-1.amazonaws.com/openshift/postgrest.yaml
|
||||
|
|
@ -70,7 +78,7 @@ https://tooljet-deployments.s3.us-west-1.amazonaws.com/openshift/postgrest.yaml
|
|||
|
||||
## Upgrading to the Latest LTS Version
|
||||
|
||||
New LTS versions are released every 3-5 months with an end-of-life of atleast 18 months. To check the latest LTS version, visit the [ToolJet Docker Hub](https://hub.docker.com/r/tooljet/tooljet/tags) page. The LTS tags follow a naming convention with the prefix `LTS-` followed by the version number, for example `tooljet/tooljet:EE-LTS-latest`.
|
||||
New LTS versions are released every 3-5 months with an end-of-life of atleast 18 months. To check the latest LTS version, visit the [ToolJet Docker Hub](https://hub.docker.com/r/tooljet/tooljet/tags) page. The LTS tags follow a naming convention with the prefix `LTS-` followed by the version number, for example `tooljet/tooljet:ee-lts-latest`.
|
||||
|
||||
If this is a new installation of the application, you may start directly with the latest version. This guide is not required for new installations.
|
||||
|
||||
|
|
@ -80,4 +88,4 @@ If this is a new installation of the application, you may start directly with th
|
|||
|
||||
- Users on versions earlier than **v2.23.0-ee2.10.2** must first upgrade to this version before proceeding to the LTS version.
|
||||
|
||||
For specific issues or questions, refer to our **[Slack](https://tooljet.slack.com/join/shared_invite/zt-25438diev-mJ6LIZpJevG0LXCEcL0NhQ#)**.
|
||||
*If you have any questions feel free to join our [Slack Community](https://tooljet.com/slack) or send us an email at hello@tooljet.com.*
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@ title: System Requirements
|
|||
This document covers all the system requirements for self-hosting ToolJet.
|
||||
|
||||
:::info
|
||||
The official Docker tag for the Enterprise Edition is tooljet/tooljet:EE-LTS-latest.
|
||||
The official Docker tag for the Enterprise Edition is tooljet/tooljet:ee-lts-latest.
|
||||
:::
|
||||
|
||||
## Operating Systems
|
||||
|
|
|
|||
|
|
@ -5,8 +5,6 @@ title: Deploying ToolJet on a subpath
|
|||
|
||||
ToolJet can now be deployed at a subpath rather than the root (`/`) of a public domain. Example subpath installation URL: **`http://www.yourcompany.com/apps/tooljet`**
|
||||
|
||||
*If you have any questions feel free to join our [Slack Community](https://tooljet.com/slack) or send us an email at hello@tooljet.com.*
|
||||
|
||||
You'll need to setup the following environment variables if ToolJet installation is on a domain subpath:
|
||||
|
||||
| variable | value |
|
||||
|
|
@ -16,7 +14,7 @@ You'll need to setup the following environment variables if ToolJet installation
|
|||
|
||||
|
||||
:::info
|
||||
See all **[Environment Variables](/docs/setup/env-vars)** here.
|
||||
See all **[Environment Variables](./env-vars)** here.
|
||||
:::
|
||||
|
||||
## Upgrading to the Latest Version
|
||||
|
|
@ -33,6 +31,4 @@ If this is a new installation of the application, you may start directly with th
|
|||
|
||||
- Users on versions earlier than v2.23.0-ee2.10.2 must first upgrade to this version before proceeding to the latest version.
|
||||
|
||||
For specific issues or questions, refer to our **[Slack](https://tooljet.slack.com/join/shared_invite/zt-25438diev-mJ6LIZpJevG0LXCEcL0NhQ#)**.
|
||||
|
||||
|
||||
*If you have any questions feel free to join our [Slack Community](https://tooljet.com/slack) or send us an email at hello@tooljet.com.*
|
||||
|
|
|
|||
|
|
@ -18,14 +18,12 @@ docker run \
|
|||
-v tooljet_data:/var/lib/postgresql/13/main \
|
||||
tooljet/try:ee-lts-latest
|
||||
```
|
||||
*If you have any questions feel free to join our [Slack Community](https://tooljet.com/slack) or send us an email at hello@tooljet.com.*
|
||||
|
||||
|
||||
#### Setup information
|
||||
|
||||
- Runs the ToolJet server on the port 80 on your machine.
|
||||
- Container has postgres already configured within. All the data will be available in the docker volume `tooljet_data`.
|
||||
- You can make use of `--env` or `--env-file` flag to test against various env configurables mentioned [here](https://docs.tooljet.com/docs/setup/env-vars).
|
||||
- You can make use of `--env` or `--env-file` flag to test against various env configurables mentioned [here](./env-vars).
|
||||
- Use `docker stop tooljet` to stop the container and `docker start tooljet` to start the container thereafter.
|
||||
|
||||
#### Dynamic Port Setup
|
||||
|
|
@ -46,3 +44,5 @@ docker run \
|
|||
- The `-e PORT=8080` flag sets the `PORT` environment variable to 8080, allowing the ToolJet server to listen on port 8080.
|
||||
|
||||
By following these instructions, you can easily run the ToolJet server on the port of your choice, ensuring flexibility in your setup.
|
||||
|
||||
*If you have any questions feel free to join our [Slack Community](https://tooljet.com/slack) or send us an email at hello@tooljet.com.*
|
||||
|
|
|
|||
|
|
@ -8,7 +8,7 @@ ToolJet has released its first Long Term Support (LTS) version, which provides e
|
|||
|
||||
### Check the latest LTS Version
|
||||
|
||||
ToolJet will be releasing new LTS versions every 3-5 months with an end-of-life of atleast 18 months. To check the latest LTS version, visit the [ToolJet Docker Hub](https://hub.docker.com/r/tooljet/tooljet/tags) page. The LTS tags follow a naming convention with the prefix `LTS-` followed by the version number, for example `tooljet/tooljet:EE-LTS-latest`.
|
||||
ToolJet will be releasing new LTS versions every 3-5 months with an end-of-life of atleast 18 months. To check the latest LTS version, visit the [ToolJet Docker Hub](https://hub.docker.com/r/tooljet/tooljet/tags) page. The LTS tags follow a naming convention with the prefix `LTS-` followed by the version number, for example `tooljet/tooljet:ee-lts-latest`.
|
||||
|
||||
### Prerequisites
|
||||
|
||||
|
|
@ -20,16 +20,14 @@ ToolJet will be releasing new LTS versions every 3-5 months with an end-of-life
|
|||
|
||||
The upgrade process depends on your deployment method. You can follow the upgrade process under the respective setup guides:
|
||||
|
||||
- [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 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)
|
||||
- [Upgrade ToolJet on Kubernetes](/docs/setup/kubernetes#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on Kubernetes(GKE)](/docs/setup/kubernetes-gke#upgrading-to-the-latest-lts-version)
|
||||
- [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)
|
||||
|
||||
|
||||
- [Upgrade ToolJet on DigitalOcean](./digitalocean#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on Docker](./docker#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on AWS EC2](./ec2#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on AWS ECS](./ecs#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on OpenShift](./openshift#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on Helm](./helm#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on Kubernetes](./kubernetes#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on Kubernetes(GKE)](./kubernetes-gke#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on Kubernetes(AKS)](./kubernetes-aks#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on Azure Container Apps](./azure-container#upgrading-to-the-latest-lts-version)
|
||||
- [Upgrade ToolJet on Google Cloud Run](./google-cloud-run#upgrading-to-the-latest-lts-version)
|
||||
|
|
|
|||
|
|
@ -24,7 +24,7 @@ Before attempting to upgrade to the ToolJet 3.0:
|
|||
To upgrade, update your Docker image to:
|
||||
|
||||
```bash
|
||||
tooljet/tooljet:v3.0.0-ee-beta.1
|
||||
tooljet/tooljet:v3.0.0-ee-lts
|
||||
```
|
||||
:::warning
|
||||
This is a beta release. Test thoroughly in a non-production environment first.
|
||||
|
|
@ -222,7 +222,9 @@ The `metadata` object will contain detailed information about the request and re
|
|||
|
||||
### ToolJet Database
|
||||
|
||||
ToolJet Database is now a core requirement for the ToolJet 3.0. The ToolJet Database will be automatically enabled and configured by default.
|
||||
ToolJet Database is now a core requirement for the ToolJet 3.0.
|
||||
To use ToolJet Database, you'd have to set up and deploy PostgREST server which helps querying ToolJet Database. Please [follow the instructions here](./env-vars/#enable-tooljet-database-required).
|
||||
|
||||
|
||||
## Help and Support
|
||||
|
||||
|
|
|
|||
|
|
@ -8,12 +8,11 @@ ToolJet version 2 comes with a bunch of exciting features, with the major ones b
|
|||
1. Multi page
|
||||
2. Multi env
|
||||
3. Forms widget
|
||||
4. [Database](/docs/tooljet-database) (Requires opt-in)
|
||||
5. [Marketplace](/docs/marketplace) (Requires opt-in)
|
||||
4. [Database](../tooljet-db/tooljet-database) (Requires opt-in)
|
||||
5. [Marketplace](../marketplace/marketplace-overview) (Requires opt-in)
|
||||
|
||||
Checkout the latest changelog for v2 [here](https://github.com/ToolJet/ToolJet/releases).
|
||||
|
||||
*If you have any questions feel free to join our [Slack Community](https://tooljet.com/slack) or send us an email at hello@tooljet.com.*
|
||||
## Deployment
|
||||
|
||||
Based on your opted deployment method from our [setup doc](/docs/setup/), you can directly deploy v2 without any additional configuration for the default setup.
|
||||
|
|
|
|||
|
|
@ -17,8 +17,6 @@ Requires:
|
|||
- PostgREST server
|
||||
- Additional configuration for ToolJet server
|
||||
|
||||
This feature is only enabled if [`ENABLE_TOOLJET_DB`](/docs/setup/env-vars#enable-tooljet-database--optional-) is set to `true`.
|
||||
|
||||
<div style={{paddingTop:'24px', paddingBottom:'24px'}}>
|
||||
|
||||
### PostgREST Server
|
||||
|
|
@ -36,8 +34,7 @@ If this parameter is not specified, then PostgREST refuses authentication reques
|
|||
| PGRST_JWT_SECRET | JWT token client provided for authentication |
|
||||
| PGRST_DB_URI | database connection string for tooljet database |
|
||||
| PGRST_LOG_LEVEL | `info` |
|
||||
| TOOLJET_DB_RECONFIG | `true` or `false` |
|
||||
| TOOLJET_DB_STATEMENT_TIMEOUT | statement timeout in milliseconds |
|
||||
| PGRST_DB_PRE_CONFIG | postgrest.pre_config |
|
||||
|
||||
:::info
|
||||
Please make sure that DB_URI is given in the format `postgres://[USERNAME]:[PASSWORD]@[HOST]:[PORT]/[DATABASE]`
|
||||
|
|
@ -50,7 +47,6 @@ Please make sure that DB_URI is given in the format `postgres://[USERNAME]:[PASS
|
|||
|
||||
| <div style={{ width:"100px"}}> Variable </div> | <div style={{ width:"100px"}}> Description </div> |
|
||||
| ------------------ | -------------------------------------------- |
|
||||
| ENABLE_TOOLJET_DB | `true` or `false` |
|
||||
| TOOLJET_DB | Default value is `tooljet_db` |
|
||||
| TOOLJET_DB_HOST | database host |
|
||||
| TOOLJET_DB_USER | database username |
|
||||
|
|
|
|||
Loading…
Reference in a new issue