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

Enhance AMI deployment documentation with AI feature whitelisting and upgrade steps

Browse source
This commit is contained in:
adishM98 Bot 2025-08-19 10:57:53 +05:30
parent 515bfb216d
commit 9f9473a4d5
1 changed files with 50 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

61
docs/versioned_docs/version-3.16.0-LTS/setup/ami.md
View file

@ -5,8 +5,12 @@ title: AWS AMI
# Deploying ToolJet on Amazon AMI
:::warning
To enable ToolJet AI features in your ToolJet deployment, whitelist https://api-gateway.tooljet.ai.
:::
:::info
You should setup a PostgreSQL database manually to be used by the ToolJet server.
You should setup a PostgreSQL database manually to be used by ToolJet. We recommend using an **RDS PostgreSQL database**. You can find the system requirements [here](/docs/3.5.0-LTS/setup/system-requirements#postgresql).
:::
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 AMI instances.
@ -22,7 +26,7 @@ Follow the steps below to deploy ToolJet on AWS AMI 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.
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_jammy` in the search bar.
4. Find the [ToolJet version](/docs/setup/choose-your-tooljet) 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. <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:
@ -88,13 +92,12 @@ Follow the steps below to deploy ToolJet on AWS AMI instances.
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://`
:::
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.
:::info
Please make sure that `TOOLJET_HOST` starts with either `http://` or `https://`
:::
11. You're all done, ToolJet client would now be served at the value you've set in `TOOLJET_HOST`.
#### Deploying ToolJet Database
@ -140,14 +143,50 @@ This setup can be deployed on a different EC2 instance. To enable seamless commu
## Upgrading to the Latest LTS Version
:::note
Users on versions earlier than **v2.23.0-ee2.10.2** must first upgrade to this version before proceeding to the 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`.
**Note**: 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.
Since ToolJet is deployed using an AMI (Amazon Machine Image), upgrading to a new LTS version requires launching a new EC2 instance with the updated AMI instead of upgrading in place.
#### Prerequisites for Upgrading to the Latest LTS Version:
#### Steps to Upgrade:
- It is crucial to perform a **comprehensive backup of your database** before starting the upgrade process to prevent data loss.
**1. Backup Your Data**
- Users on versions earlier than **v2.23.0-ee2.10.2** must first upgrade to this version before proceeding to the LTS version.
- Perform a comprehensive backup of your PostgreSQL database to prevent data loss.
**2. Copy the .env File from the old Instance**
- Before stopping the old instance, copy the `.env` file and store it safely.
**3. Stop the old EC2 Instance**
- To prevent conflicts, stop the old EC2 instance before proceeding with the new deployment.
- Ensure that the old instance remains stopped while setting up the new one.
**4. Launch a New EC2 Instance with the Latest AMI**
- Go to the AWS AMI dashboard and find the latest ToolJet AMI.
- Launch a new EC2 instance using this AMI.
- Configure security group rules as needed.
**5. Transfer the .env File to the New Instance**
- Upload the saved `.env` file to the appropriate directory on the new instance.
**6. Start the Application**
- SSH into the new instance, navigate to the app directory, and run the setup script:
```bash
cd ~/app
./setup_app
```
**7. Terminate the Old EC2 Instance**
- After verifying that ToolJet is running correctly on the new instance, terminate the old EC2 instance to avoid unnecessary costs.
_If you have any questions feel free to join our [Slack Community](https://join.slack.com/t/tooljet/shared_invite/zt-2rk4w42t0-ZV_KJcWU9VL1BBEjnSHLCA) or send us an email at hello@tooljet.com._