Merge pull request #8084 from ToolJet/docs/codespace

[doc]codespaces guide

docs/docs/contributing-guide/setup/codespaces.md

@@ -0,0 +1,117 @@
+---
+id: codespaces
+title: GitHub Codespaces
+---
+
+Follow the steps below to set up ToolJet on GitHub Codespaces. We recommend reading our guide on [architecture](https://docs.tooljet.com/docs/contributing-guide/setup/architecture) of ToolJet before proceeding.
+
+Open the terminal and run the commands below.
+
+## Setting up
+
+### 1. Set up the environment 
+
+1. Install Node.js ( version: v18.3.0 ) and npm (version: v8.11.0)
+
+```
+nvm install 18.3.0
+nvm use 18.3.0
+npm install -g npm@8.11.0
+```
+
+2. Install Postgres
+
+```
+sudo sh -c 'echo "deb [http://apt.postgresql.org/pub/repos/apt](http://apt.postgresql.org/pub/repos/apt) $(lsb_release -cs)-pgdg main" > /etc/apt/sources.list.d/pgdg.list'
+
+wget --quiet -O - [https://www.postgresql.org/media/keys/ACCC4CF8.asc](https://www.postgresql.org/media/keys/ACCC4CF8.asc) | sudo apt-key add -
+
+sudo apt-get update
+
+sudo apt-get install postgresql-13 postgresql-contrib-13
+```
+
+To start the postgresql service run the below command: 
+
+```
+sudo service postgresql start
+```
+
+If you wish to change the password of the installed postresql service run the below commands:
+
+```
+sudo su
+
+sudo -u postgres psql
+
+\password postgres  
+
+\q
+```
+
+### 2. Set up environment variables
+
+Create a `.env` file by running the command `touch .env`. More information on the variables that can be set is given in the [environment variables reference](https://docs.tooljet.com/docs/setup/env-vars)
+
+**For basic set-up you add the below env variables:**
+
+```
+TOOLJET_HOST=http://localhost:3000
+
+LOCKBOX_MASTER_KEY=
+
+SECRET_KEY_BASE=
+
+PG_USER=postgres
+
+PG_HOST=localhost
+
+PG_PASS=postgres
+
+PG_DB=tooljet_prod
+
+SUB_PATH=/apps/tooljet/
+
+NODE_ENV=production
+
+SERVE_CLIENT=true
+```
+
+> `SECRET_KEY_BASE` requires a 64 byte key. (If you have `openssl` installed, run `openssl rand -hex 64` to create a 64 byte secure random key)
+>
+> `LOCKBOX_MASTER_KEY` requires a 32 byte key. (Run `openssl rand -hex 32` to create a 32 byte secure random key)
+
+### 3.  Install and build dependencies
+
+Make sure node version is set to 18.3.0 before running the below command:
+
+```
+npm install
+npm install --prefix server
+npm install --prefix frontend
+npm run build:plugins
+```
+
+
+### 4. Set up database
+
+```
+npm run --prefix server db:create
+npm run --prefix server db:mirgate
+```
+
+If at any point you need to reset the database, use this command `npm run --prefix server db:reset`
+
+### 5. Build client
+
+```
+cd ./frontend && NODE=production npm run build
+```
+
+### 6. Run server
+
+```
+cd ./server && npm run start:prod
+```
+
+The client will start on the **port 3000**, you can access the client by visiting the url created by codespace - `https://<url>/apps/tooljet`

docs/docs/setup/ec2.md

@@ -11,6 +11,13 @@ 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:
+```
+curl -LO https://tooljet-deployments.s3.us-west-1.amazonaws.com/cloudformation/EC2-cloudfomration.yml
+```
+
 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.

docs/docs/setup/try-tooljet.md

@@ -10,10 +10,11 @@ title: Try ToolJet
 You can run the command below to have ToolJet up and running right away.
 
 ```bash
-docker run \
+docker run -d \
   --name tooljet \
   --restart unless-stopped \
   -p 80:80 \
+  --platform linux/amd64 \
   -v tooljet_data:/var/lib/postgresql/13/main \
   tooljet/try:latest
 ```

docs/sidebars.js

@@ -384,6 +384,7 @@ const sidebars = {
           'type': 'category',
           'label': 'Setup',
           'items': [
+            'contributing-guide/setup/codespaces',
             'contributing-guide/setup/macos',
             'contributing-guide/setup/docker',
             'contributing-guide/setup/ubuntu',

docs/versioned_docs/version-1.x.x/setup/try-tooljet.md

@@ -9,10 +9,11 @@ title: Try ToolJet
 You can run the command below to have ToolJet up and running right away.
 
 ```bash
-docker run \
+docker run -d \
   --name tooljet \
   --restart unless-stopped \
-  -p 3000:3000 \
+  -p 80:80 \
+  --platform linux/amd64 \
   -v tooljet_data:/var/lib/postgresql/13/main \
   tooljet/try:latest
 ```

docs/versioned_docs/version-2.0.0/setup/try-tooljet.md

@@ -9,10 +9,11 @@ title: Try ToolJet
 You can run the command below to have ToolJet up and running right away.
 
 ```bash
-docker run \
+docker run -d \
   --name tooljet \
   --restart unless-stopped \
   -p 80:80 \
+  --platform linux/amd64 \
   -v tooljet_data:/var/lib/postgresql/13/main \
   tooljet/try:latest
 ```

docs/versioned_docs/version-2.1.0/setup/try-tooljet.md

@@ -9,10 +9,11 @@ title: Try ToolJet
 You can run the command below to have ToolJet up and running right away.
 
 ```bash
-docker run \
+docker run -d \
   --name tooljet \
   --restart unless-stopped \
   -p 80:80 \
+  --platform linux/amd64 \
   -v tooljet_data:/var/lib/postgresql/13/main \
   tooljet/try:latest
 ```

docs/versioned_docs/version-2.10.0/setup/try-tooljet.md

@@ -9,10 +9,11 @@ title: Try ToolJet
 You can run the command below to have ToolJet up and running right away.
 
 ```bash
-docker run \
+docker run -d \
   --name tooljet \
   --restart unless-stopped \
   -p 80:80 \
+  --platform linux/amd64 \
   -v tooljet_data:/var/lib/postgresql/13/main \
   tooljet/try:latest
 ```

docs/versioned_docs/version-2.11.0/setup/try-tooljet.md

@@ -9,10 +9,11 @@ title: Try ToolJet
 You can run the command below to have ToolJet up and running right away.
 
 ```bash
-docker run \
+docker run -d \
   --name tooljet \
   --restart unless-stopped \
   -p 80:80 \
+  --platform linux/amd64 \
   -v tooljet_data:/var/lib/postgresql/13/main \
   tooljet/try:latest
 ```

docs/versioned_docs/version-2.12.0/setup/try-tooljet.md

@@ -10,16 +10,16 @@ title: Try ToolJet
 You can run the command below to have ToolJet up and running right away.
 
 ```bash
-docker run \
+docker run -d \
   --name tooljet \
   --restart unless-stopped \
   -p 80:80 \
+  --platform linux/amd64 \
   -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.

docs/versioned_docs/version-2.13.0/setup/try-tooljet.md

@@ -10,16 +10,16 @@ title: Try ToolJet
 You can run the command below to have ToolJet up and running right away.
 
 ```bash
-docker run \
+docker run -d \
   --name tooljet \
   --restart unless-stopped \
   -p 80:80 \
+  --platform linux/amd64 \
   -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.

docs/versioned_docs/version-2.14.0/setup/try-tooljet.md

@@ -10,16 +10,16 @@ title: Try ToolJet
 You can run the command below to have ToolJet up and running right away.
 
 ```bash
-docker run \
+docker run -d \
   --name tooljet \
   --restart unless-stopped \
   -p 80:80 \
+  --platform linux/amd64 \
   -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.

docs/versioned_docs/version-2.15.0/contributing-guide/setup/codespaces.md

@@ -0,0 +1,117 @@
+---
+id: codespaces
+title: GitHub Codespaces
+---
+
+Follow the steps below to set up ToolJet on GitHub Codespaces. We recommend reading our guide on [architecture](https://docs.tooljet.com/docs/contributing-guide/setup/architecture) of ToolJet before proceeding.
+
+Open the terminal and run the commands below.
+
+## Setting up
+
+### 1. Set up the environment 
+
+1. Install Node.js ( version: v18.3.0 ) and npm (version: v8.11.0)
+
+```
+nvm install 18.3.0
+nvm use 18.3.0
+npm install -g npm@8.11.0
+```
+
+2. Install Postgres
+
+```
+sudo sh -c 'echo "deb [http://apt.postgresql.org/pub/repos/apt](http://apt.postgresql.org/pub/repos/apt) $(lsb_release -cs)-pgdg main" > /etc/apt/sources.list.d/pgdg.list'
+
+wget --quiet -O - [https://www.postgresql.org/media/keys/ACCC4CF8.asc](https://www.postgresql.org/media/keys/ACCC4CF8.asc) | sudo apt-key add -
+
+sudo apt-get update
+
+sudo apt-get install postgresql-13 postgresql-contrib-13
+```
+
+To start the postgresql service run the below command: 
+
+```
+sudo service postgresql start
+```
+
+If you wish to change the password of the installed postresql service run the below commands:
+
+```
+sudo su
+
+sudo -u postgres psql
+
+\password postgres  
+
+\q
+```
+
+### 2. Set up environment variables
+
+Create a `.env` file by running the command `touch .env`. More information on the variables that can be set is given in the [environment variables reference](https://docs.tooljet.com/docs/setup/env-vars)
+
+**For basic set-up you add the below env variables:**
+
+```
+TOOLJET_HOST=http://localhost:3000
+
+LOCKBOX_MASTER_KEY=
+
+SECRET_KEY_BASE=
+
+PG_USER=postgres
+
+PG_HOST=localhost
+
+PG_PASS=postgres
+
+PG_DB=tooljet_prod
+
+SUB_PATH=/apps/tooljet/
+
+NODE_ENV=production
+
+SERVE_CLIENT=true
+```
+
+> `SECRET_KEY_BASE` requires a 64 byte key. (If you have `openssl` installed, run `openssl rand -hex 64` to create a 64 byte secure random key)
+>
+> `LOCKBOX_MASTER_KEY` requires a 32 byte key. (Run `openssl rand -hex 32` to create a 32 byte secure random key)
+
+### 3.  Install and build dependencies
+
+Make sure node version is set to 18.3.0 before running the below command:
+
+```
+npm install
+npm install --prefix server
+npm install --prefix frontend
+npm run build:plugins
+```
+
+
+### 4. Set up database
+
+```
+npm run --prefix server db:create
+npm run --prefix server db:mirgate
+```
+
+If at any point you need to reset the database, use this command `npm run --prefix server db:reset`
+
+### 5. Build client
+
+```
+cd ./frontend && NODE=production npm run build
+```
+
+### 6. Run server
+
+```
+cd ./server && npm run start:prod
+```
+
+The client will start on the **port 3000**, you can access the client by visiting the url created by codespace - `https://<url>/apps/tooljet`

docs/versioned_docs/version-2.15.0/setup/ec2.md

@@ -11,6 +11,13 @@ 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:
+```
+curl -LO https://tooljet-deployments.s3.us-west-1.amazonaws.com/cloudformation/EC2-cloudfomration.yml
+```
+
 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.

docs/versioned_docs/version-2.15.0/setup/try-tooljet.md

@@ -10,16 +10,16 @@ title: Try ToolJet
 You can run the command below to have ToolJet up and running right away.
 
 ```bash
-docker run \
+docker run -d \
   --name tooljet \
   --restart unless-stopped \
   -p 80:80 \
+  --platform linux/amd64 \
   -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.

docs/versioned_docs/version-2.16.0/contributing-guide/setup/codespaces.md

@@ -0,0 +1,117 @@
+---
+id: codespaces
+title: GitHub Codespaces
+---
+
+Follow the steps below to set up ToolJet on GitHub Codespaces. We recommend reading our guide on [architecture](https://docs.tooljet.com/docs/contributing-guide/setup/architecture) of ToolJet before proceeding.
+
+Open the terminal and run the commands below.
+
+## Setting up
+
+### 1. Set up the environment 
+
+1. Install Node.js ( version: v18.3.0 ) and npm (version: v8.11.0)
+
+```
+nvm install 18.3.0
+nvm use 18.3.0
+npm install -g npm@8.11.0
+```
+
+2. Install Postgres
+
+```
+sudo sh -c 'echo "deb [http://apt.postgresql.org/pub/repos/apt](http://apt.postgresql.org/pub/repos/apt) $(lsb_release -cs)-pgdg main" > /etc/apt/sources.list.d/pgdg.list'
+
+wget --quiet -O - [https://www.postgresql.org/media/keys/ACCC4CF8.asc](https://www.postgresql.org/media/keys/ACCC4CF8.asc) | sudo apt-key add -
+
+sudo apt-get update
+
+sudo apt-get install postgresql-13 postgresql-contrib-13
+```
+
+To start the postgresql service run the below command: 
+
+```
+sudo service postgresql start
+```
+
+If you wish to change the password of the installed postresql service run the below commands:
+
+```
+sudo su
+
+sudo -u postgres psql
+
+\password postgres  
+
+\q
+```
+
+### 2. Set up environment variables
+
+Create a `.env` file by running the command `touch .env`. More information on the variables that can be set is given in the [environment variables reference](https://docs.tooljet.com/docs/setup/env-vars)
+
+**For basic set-up you add the below env variables:**
+
+```
+TOOLJET_HOST=http://localhost:3000
+
+LOCKBOX_MASTER_KEY=
+
+SECRET_KEY_BASE=
+
+PG_USER=postgres
+
+PG_HOST=localhost
+
+PG_PASS=postgres
+
+PG_DB=tooljet_prod
+
+SUB_PATH=/apps/tooljet/
+
+NODE_ENV=production
+
+SERVE_CLIENT=true
+```
+
+> `SECRET_KEY_BASE` requires a 64 byte key. (If you have `openssl` installed, run `openssl rand -hex 64` to create a 64 byte secure random key)
+>
+> `LOCKBOX_MASTER_KEY` requires a 32 byte key. (Run `openssl rand -hex 32` to create a 32 byte secure random key)
+
+### 3.  Install and build dependencies
+
+Make sure node version is set to 18.3.0 before running the below command:
+
+```
+npm install
+npm install --prefix server
+npm install --prefix frontend
+npm run build:plugins
+```
+
+
+### 4. Set up database
+
+```
+npm run --prefix server db:create
+npm run --prefix server db:mirgate
+```
+
+If at any point you need to reset the database, use this command `npm run --prefix server db:reset`
+
+### 5. Build client
+
+```
+cd ./frontend && NODE=production npm run build
+```
+
+### 6. Run server
+
+```
+cd ./server && npm run start:prod
+```
+
+The client will start on the **port 3000**, you can access the client by visiting the url created by codespace - `https://<url>/apps/tooljet`

docs/versioned_docs/version-2.16.0/setup/ec2.md

@@ -11,6 +11,13 @@ 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:
+```
+curl -LO https://tooljet-deployments.s3.us-west-1.amazonaws.com/cloudformation/EC2-cloudfomration.yml
+```
+
 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.

docs/versioned_docs/version-2.16.0/setup/try-tooljet.md

@@ -10,16 +10,16 @@ title: Try ToolJet
 You can run the command below to have ToolJet up and running right away.
 
 ```bash
-docker run \
+docker run -d \
   --name tooljet \
   --restart unless-stopped \
   -p 80:80 \
+  --platform linux/amd64 \
   -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.

docs/versioned_docs/version-2.17.0/contributing-guide/setup/codespaces.md

@@ -0,0 +1,117 @@
+---
+id: codespaces
+title: GitHub Codespaces
+---
+
+Follow the steps below to set up ToolJet on GitHub Codespaces. We recommend reading our guide on [architecture](https://docs.tooljet.com/docs/contributing-guide/setup/architecture) of ToolJet before proceeding.
+
+Open the terminal and run the commands below.
+
+## Setting up
+
+### 1. Set up the environment 
+
+1. Install Node.js ( version: v18.3.0 ) and npm (version: v8.11.0)
+
+```
+nvm install 18.3.0
+nvm use 18.3.0
+npm install -g npm@8.11.0
+```
+
+2. Install Postgres
+
+```
+sudo sh -c 'echo "deb [http://apt.postgresql.org/pub/repos/apt](http://apt.postgresql.org/pub/repos/apt) $(lsb_release -cs)-pgdg main" > /etc/apt/sources.list.d/pgdg.list'
+
+wget --quiet -O - [https://www.postgresql.org/media/keys/ACCC4CF8.asc](https://www.postgresql.org/media/keys/ACCC4CF8.asc) | sudo apt-key add -
+
+sudo apt-get update
+
+sudo apt-get install postgresql-13 postgresql-contrib-13
+```
+
+To start the postgresql service run the below command: 
+
+```
+sudo service postgresql start
+```
+
+If you wish to change the password of the installed postresql service run the below commands:
+
+```
+sudo su
+
+sudo -u postgres psql
+
+\password postgres  
+
+\q
+```
+
+### 2. Set up environment variables
+
+Create a `.env` file by running the command `touch .env`. More information on the variables that can be set is given in the [environment variables reference](https://docs.tooljet.com/docs/setup/env-vars)
+
+**For basic set-up you add the below env variables:**
+
+```
+TOOLJET_HOST=http://localhost:3000
+
+LOCKBOX_MASTER_KEY=
+
+SECRET_KEY_BASE=
+
+PG_USER=postgres
+
+PG_HOST=localhost
+
+PG_PASS=postgres
+
+PG_DB=tooljet_prod
+
+SUB_PATH=/apps/tooljet/
+
+NODE_ENV=production
+
+SERVE_CLIENT=true
+```
+
+> `SECRET_KEY_BASE` requires a 64 byte key. (If you have `openssl` installed, run `openssl rand -hex 64` to create a 64 byte secure random key)
+>
+> `LOCKBOX_MASTER_KEY` requires a 32 byte key. (Run `openssl rand -hex 32` to create a 32 byte secure random key)
+
+### 3.  Install and build dependencies
+
+Make sure node version is set to 18.3.0 before running the below command:
+
+```
+npm install
+npm install --prefix server
+npm install --prefix frontend
+npm run build:plugins
+```
+
+
+### 4. Set up database
+
+```
+npm run --prefix server db:create
+npm run --prefix server db:mirgate
+```
+
+If at any point you need to reset the database, use this command `npm run --prefix server db:reset`
+
+### 5. Build client
+
+```
+cd ./frontend && NODE=production npm run build
+```
+
+### 6. Run server
+
+```
+cd ./server && npm run start:prod
+```
+
+The client will start on the **port 3000**, you can access the client by visiting the url created by codespace - `https://<url>/apps/tooljet`

docs/versioned_docs/version-2.17.0/setup/ec2.md

@@ -11,6 +11,13 @@ 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:
+```
+curl -LO https://tooljet-deployments.s3.us-west-1.amazonaws.com/cloudformation/EC2-cloudfomration.yml
+```
+
 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.

docs/versioned_docs/version-2.17.0/setup/try-tooljet.md

@@ -10,16 +10,16 @@ title: Try ToolJet
 You can run the command below to have ToolJet up and running right away.
 
 ```bash
-docker run \
+docker run -d \
   --name tooljet \
   --restart unless-stopped \
   -p 80:80 \
+  --platform linux/amd64 \
   -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.

docs/versioned_docs/version-2.18.0/contributing-guide/setup/codespaces.md

@@ -0,0 +1,117 @@
+---
+id: codespaces
+title: GitHub Codespaces
+---
+
+Follow the steps below to set up ToolJet on GitHub Codespaces. We recommend reading our guide on [architecture](https://docs.tooljet.com/docs/contributing-guide/setup/architecture) of ToolJet before proceeding.
+
+Open the terminal and run the commands below.
+
+## Setting up
+
+### 1. Set up the environment 
+
+1. Install Node.js ( version: v18.3.0 ) and npm (version: v8.11.0)
+
+```
+nvm install 18.3.0
+nvm use 18.3.0
+npm install -g npm@8.11.0
+```
+
+2. Install Postgres
+
+```
+sudo sh -c 'echo "deb [http://apt.postgresql.org/pub/repos/apt](http://apt.postgresql.org/pub/repos/apt) $(lsb_release -cs)-pgdg main" > /etc/apt/sources.list.d/pgdg.list'
+
+wget --quiet -O - [https://www.postgresql.org/media/keys/ACCC4CF8.asc](https://www.postgresql.org/media/keys/ACCC4CF8.asc) | sudo apt-key add -
+
+sudo apt-get update
+
+sudo apt-get install postgresql-13 postgresql-contrib-13
+```
+
+To start the postgresql service run the below command: 
+
+```
+sudo service postgresql start
+```
+
+If you wish to change the password of the installed postresql service run the below commands:
+
+```
+sudo su
+
+sudo -u postgres psql
+
+\password postgres  
+
+\q
+```
+
+### 2. Set up environment variables
+
+Create a `.env` file by running the command `touch .env`. More information on the variables that can be set is given in the [environment variables reference](https://docs.tooljet.com/docs/setup/env-vars)
+
+**For basic set-up you add the below env variables:**
+
+```
+TOOLJET_HOST=http://localhost:3000
+
+LOCKBOX_MASTER_KEY=
+
+SECRET_KEY_BASE=
+
+PG_USER=postgres
+
+PG_HOST=localhost
+
+PG_PASS=postgres
+
+PG_DB=tooljet_prod
+
+SUB_PATH=/apps/tooljet/
+
+NODE_ENV=production
+
+SERVE_CLIENT=true
+```
+
+> `SECRET_KEY_BASE` requires a 64 byte key. (If you have `openssl` installed, run `openssl rand -hex 64` to create a 64 byte secure random key)
+>
+> `LOCKBOX_MASTER_KEY` requires a 32 byte key. (Run `openssl rand -hex 32` to create a 32 byte secure random key)
+
+### 3.  Install and build dependencies
+
+Make sure node version is set to 18.3.0 before running the below command:
+
+```
+npm install
+npm install --prefix server
+npm install --prefix frontend
+npm run build:plugins
+```
+
+
+### 4. Set up database
+
+```
+npm run --prefix server db:create
+npm run --prefix server db:mirgate
+```
+
+If at any point you need to reset the database, use this command `npm run --prefix server db:reset`
+
+### 5. Build client
+
+```
+cd ./frontend && NODE=production npm run build
+```
+
+### 6. Run server
+
+```
+cd ./server && npm run start:prod
+```
+
+The client will start on the **port 3000**, you can access the client by visiting the url created by codespace - `https://<url>/apps/tooljet`

docs/versioned_docs/version-2.18.0/setup/ec2.md

@@ -11,6 +11,13 @@ 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:
+```
+curl -LO https://tooljet-deployments.s3.us-west-1.amazonaws.com/cloudformation/EC2-cloudfomration.yml
+```
+
 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.

docs/versioned_docs/version-2.18.0/setup/try-tooljet.md

@@ -10,16 +10,16 @@ title: Try ToolJet
 You can run the command below to have ToolJet up and running right away.
 
 ```bash
-docker run \
+docker run -d \
   --name tooljet \
   --restart unless-stopped \
   -p 80:80 \
+  --platform linux/amd64 \
   -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.

docs/versioned_docs/version-2.19.0/contributing-guide/setup/codespaces.md

@@ -0,0 +1,117 @@
+---
+id: codespaces
+title: GitHub Codespaces
+---
+
+Follow the steps below to set up ToolJet on GitHub Codespaces. We recommend reading our guide on [architecture](https://docs.tooljet.com/docs/contributing-guide/setup/architecture) of ToolJet before proceeding.
+
+Open the terminal and run the commands below.
+
+## Setting up
+
+### 1. Set up the environment 
+
+1. Install Node.js ( version: v18.3.0 ) and npm (version: v8.11.0)
+
+```
+nvm install 18.3.0
+nvm use 18.3.0
+npm install -g npm@8.11.0
+```
+
+2. Install Postgres
+
+```
+sudo sh -c 'echo "deb [http://apt.postgresql.org/pub/repos/apt](http://apt.postgresql.org/pub/repos/apt) $(lsb_release -cs)-pgdg main" > /etc/apt/sources.list.d/pgdg.list'
+
+wget --quiet -O - [https://www.postgresql.org/media/keys/ACCC4CF8.asc](https://www.postgresql.org/media/keys/ACCC4CF8.asc) | sudo apt-key add -
+
+sudo apt-get update
+
+sudo apt-get install postgresql-13 postgresql-contrib-13
+```
+
+To start the postgresql service run the below command: 
+
+```
+sudo service postgresql start
+```
+
+If you wish to change the password of the installed postresql service run the below commands:
+
+```
+sudo su
+
+sudo -u postgres psql
+
+\password postgres  
+
+\q
+```
+
+### 2. Set up environment variables
+
+Create a `.env` file by running the command `touch .env`. More information on the variables that can be set is given in the [environment variables reference](https://docs.tooljet.com/docs/setup/env-vars)
+
+**For basic set-up you add the below env variables:**
+
+```
+TOOLJET_HOST=http://localhost:3000
+
+LOCKBOX_MASTER_KEY=
+
+SECRET_KEY_BASE=
+
+PG_USER=postgres
+
+PG_HOST=localhost
+
+PG_PASS=postgres
+
+PG_DB=tooljet_prod
+
+SUB_PATH=/apps/tooljet/
+
+NODE_ENV=production
+
+SERVE_CLIENT=true
+```
+
+> `SECRET_KEY_BASE` requires a 64 byte key. (If you have `openssl` installed, run `openssl rand -hex 64` to create a 64 byte secure random key)
+>
+> `LOCKBOX_MASTER_KEY` requires a 32 byte key. (Run `openssl rand -hex 32` to create a 32 byte secure random key)
+
+### 3.  Install and build dependencies
+
+Make sure node version is set to 18.3.0 before running the below command:
+
+```
+npm install
+npm install --prefix server
+npm install --prefix frontend
+npm run build:plugins
+```
+
+
+### 4. Set up database
+
+```
+npm run --prefix server db:create
+npm run --prefix server db:mirgate
+```
+
+If at any point you need to reset the database, use this command `npm run --prefix server db:reset`
+
+### 5. Build client
+
+```
+cd ./frontend && NODE=production npm run build
+```
+
+### 6. Run server
+
+```
+cd ./server && npm run start:prod
+```
+
+The client will start on the **port 3000**, you can access the client by visiting the url created by codespace - `https://<url>/apps/tooljet`

docs/versioned_docs/version-2.19.0/setup/ec2.md

@@ -11,6 +11,13 @@ 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:
+```
+curl -LO https://tooljet-deployments.s3.us-west-1.amazonaws.com/cloudformation/EC2-cloudfomration.yml
+```
+
 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.

docs/versioned_docs/version-2.19.0/setup/try-tooljet.md

@@ -10,16 +10,16 @@ title: Try ToolJet
 You can run the command below to have ToolJet up and running right away.
 
 ```bash
-docker run \
+docker run -d \
   --name tooljet \
   --restart unless-stopped \
   -p 80:80 \
+  --platform linux/amd64 \
   -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.

docs/versioned_docs/version-2.2.0/setup/try-tooljet.md

@@ -4,15 +4,17 @@ title: Try ToolJet
 ---
 
 # Try ToolJet
+
 ## On local with Docker
 
 You can run the command below to have ToolJet up and running right away.
 
 ```bash
-docker run \
+docker run -d \
   --name tooljet \
   --restart unless-stopped \
   -p 80:80 \
+  --platform linux/amd64 \
   -v tooljet_data:/var/lib/postgresql/13/main \
   tooljet/try:latest
 ```

docs/versioned_docs/version-2.22.0/contributing-guide/setup/codespaces.md

@@ -0,0 +1,117 @@
+---
+id: codespaces
+title: GitHub Codespaces
+---
+
+Follow the steps below to set up ToolJet on GitHub Codespaces. We recommend reading our guide on [architecture](https://docs.tooljet.com/docs/contributing-guide/setup/architecture) of ToolJet before proceeding.
+
+Open the terminal and run the commands below.
+
+## Setting up
+
+### 1. Set up the environment 
+
+1. Install Node.js ( version: v18.3.0 ) and npm (version: v8.11.0)
+
+```
+nvm install 18.3.0
+nvm use 18.3.0
+npm install -g npm@8.11.0
+```
+
+2. Install Postgres
+
+```
+sudo sh -c 'echo "deb [http://apt.postgresql.org/pub/repos/apt](http://apt.postgresql.org/pub/repos/apt) $(lsb_release -cs)-pgdg main" > /etc/apt/sources.list.d/pgdg.list'
+
+wget --quiet -O - [https://www.postgresql.org/media/keys/ACCC4CF8.asc](https://www.postgresql.org/media/keys/ACCC4CF8.asc) | sudo apt-key add -
+
+sudo apt-get update
+
+sudo apt-get install postgresql-13 postgresql-contrib-13
+```
+
+To start the postgresql service run the below command: 
+
+```
+sudo service postgresql start
+```
+
+If you wish to change the password of the installed postresql service run the below commands:
+
+```
+sudo su
+
+sudo -u postgres psql
+
+\password postgres  
+
+\q
+```
+
+### 2. Set up environment variables
+
+Create a `.env` file by running the command `touch .env`. More information on the variables that can be set is given in the [environment variables reference](https://docs.tooljet.com/docs/setup/env-vars)
+
+**For basic set-up you add the below env variables:**
+
+```
+TOOLJET_HOST=http://localhost:3000
+
+LOCKBOX_MASTER_KEY=
+
+SECRET_KEY_BASE=
+
+PG_USER=postgres
+
+PG_HOST=localhost
+
+PG_PASS=postgres
+
+PG_DB=tooljet_prod
+
+SUB_PATH=/apps/tooljet/
+
+NODE_ENV=production
+
+SERVE_CLIENT=true
+```
+
+> `SECRET_KEY_BASE` requires a 64 byte key. (If you have `openssl` installed, run `openssl rand -hex 64` to create a 64 byte secure random key)
+>
+> `LOCKBOX_MASTER_KEY` requires a 32 byte key. (Run `openssl rand -hex 32` to create a 32 byte secure random key)
+
+### 3.  Install and build dependencies
+
+Make sure node version is set to 18.3.0 before running the below command:
+
+```
+npm install
+npm install --prefix server
+npm install --prefix frontend
+npm run build:plugins
+```
+
+
+### 4. Set up database
+
+```
+npm run --prefix server db:create
+npm run --prefix server db:mirgate
+```
+
+If at any point you need to reset the database, use this command `npm run --prefix server db:reset`
+
+### 5. Build client
+
+```
+cd ./frontend && NODE=production npm run build
+```
+
+### 6. Run server
+
+```
+cd ./server && npm run start:prod
+```
+
+The client will start on the **port 3000**, you can access the client by visiting the url created by codespace - `https://<url>/apps/tooljet`

docs/versioned_docs/version-2.22.0/setup/ec2.md

@@ -11,6 +11,13 @@ 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:
+```
+curl -LO https://tooljet-deployments.s3.us-west-1.amazonaws.com/cloudformation/EC2-cloudfomration.yml
+```
+
 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.

docs/versioned_docs/version-2.22.0/setup/try-tooljet.md

@@ -10,16 +10,16 @@ title: Try ToolJet
 You can run the command below to have ToolJet up and running right away.
 
 ```bash
-docker run \
+docker run -d \
   --name tooljet \
   --restart unless-stopped \
   -p 80:80 \
+  --platform linux/amd64 \
   -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.

docs/versioned_docs/version-2.3.0/setup/try-tooljet.md

@@ -4,15 +4,17 @@ title: Try ToolJet
 ---
 
 # Try ToolJet
+
 ## On local with Docker
 
 You can run the command below to have ToolJet up and running right away.
 
 ```bash
-docker run \
+docker run -d \
   --name tooljet \
   --restart unless-stopped \
   -p 80:80 \
+  --platform linux/amd64 \
   -v tooljet_data:/var/lib/postgresql/13/main \
   tooljet/try:latest
 ```

docs/versioned_docs/version-2.4.0/setup/try-tooljet.md

@@ -4,15 +4,17 @@ title: Try ToolJet
 ---
 
 # Try ToolJet
+
 ## On local with Docker
 
 You can run the command below to have ToolJet up and running right away.
 
 ```bash
-docker run \
+docker run -d \
   --name tooljet \
   --restart unless-stopped \
   -p 80:80 \
+  --platform linux/amd64 \
   -v tooljet_data:/var/lib/postgresql/13/main \
   tooljet/try:latest
 ```

docs/versioned_docs/version-2.5.0/setup/try-tooljet.md

@@ -4,15 +4,17 @@ title: Try ToolJet
 ---
 
 # Try ToolJet
+
 ## On local with Docker
 
 You can run the command below to have ToolJet up and running right away.
 
 ```bash
-docker run \
+docker run -d \
   --name tooljet \
   --restart unless-stopped \
   -p 80:80 \
+  --platform linux/amd64 \
   -v tooljet_data:/var/lib/postgresql/13/main \
   tooljet/try:latest
 ```

docs/versioned_docs/version-2.6.0/setup/try-tooljet.md

@@ -4,15 +4,17 @@ title: Try ToolJet
 ---
 
 # Try ToolJet
+
 ## On local with Docker
 
 You can run the command below to have ToolJet up and running right away.
 
 ```bash
-docker run \
+docker run -d \
   --name tooljet \
   --restart unless-stopped \
   -p 80:80 \
+  --platform linux/amd64 \
   -v tooljet_data:/var/lib/postgresql/13/main \
   tooljet/try:latest
 ```

docs/versioned_docs/version-2.7.0/setup/try-tooljet.md

@@ -4,15 +4,17 @@ title: Try ToolJet
 ---
 
 # Try ToolJet
+
 ## On local with Docker
 
 You can run the command below to have ToolJet up and running right away.
 
 ```bash
-docker run \
+docker run -d \
   --name tooljet \
   --restart unless-stopped \
   -p 80:80 \
+  --platform linux/amd64 \
   -v tooljet_data:/var/lib/postgresql/13/main \
   tooljet/try:latest
 ```

docs/versioned_docs/version-2.8.0/setup/try-tooljet.md

@@ -4,15 +4,17 @@ title: Try ToolJet
 ---
 
 # Try ToolJet
+
 ## On local with Docker
 
 You can run the command below to have ToolJet up and running right away.
 
 ```bash
-docker run \
+docker run -d \
   --name tooljet \
   --restart unless-stopped \
   -p 80:80 \
+  --platform linux/amd64 \
   -v tooljet_data:/var/lib/postgresql/13/main \
   tooljet/try:latest
 ```

docs/versioned_docs/version-2.9.0/setup/try-tooljet.md

@@ -4,15 +4,17 @@ title: Try ToolJet
 ---
 
 # Try ToolJet
+
 ## On local with Docker
 
 You can run the command below to have ToolJet up and running right away.
 
 ```bash
-docker run \
+docker run -d \
   --name tooljet \
   --restart unless-stopped \
   -p 80:80 \
+  --platform linux/amd64 \
   -v tooljet_data:/var/lib/postgresql/13/main \
   tooljet/try:latest
 ```

docs/versioned_docs/version-2.9.4/setup/try-tooljet.md

@@ -4,15 +4,17 @@ title: Try ToolJet
 ---
 
 # Try ToolJet
+
 ## On local with Docker
 
 You can run the command below to have ToolJet up and running right away.
 
 ```bash
-docker run \
+docker run -d \
   --name tooljet \
   --restart unless-stopped \
   -p 80:80 \
+  --platform linux/amd64 \
   -v tooljet_data:/var/lib/postgresql/13/main \
   tooljet/try:latest
 ```

docs/versioned_sidebars/version-2.15.0-sidebars.json

@@ -372,6 +372,7 @@
           "type": "category",
           "label": "Setup",
           "items": [
+            "contributing-guide/setup/codespaces",
             "contributing-guide/setup/macos",
             "contributing-guide/setup/docker",
             "contributing-guide/setup/ubuntu",

docs/versioned_sidebars/version-2.16.0-sidebars.json

@@ -373,6 +373,7 @@
           "type": "category",
           "label": "Setup",
           "items": [
+            "contributing-guide/setup/codespaces",
             "contributing-guide/setup/macos",
             "contributing-guide/setup/docker",
             "contributing-guide/setup/ubuntu",

docs/versioned_sidebars/version-2.17.0-sidebars.json

@@ -372,6 +372,7 @@
           "type": "category",
           "label": "Setup",
           "items": [
+            "contributing-guide/setup/codespaces",
             "contributing-guide/setup/macos",
             "contributing-guide/setup/docker",
             "contributing-guide/setup/ubuntu",

docs/versioned_sidebars/version-2.18.0-sidebars.json

@@ -372,6 +372,7 @@
           "type": "category",
           "label": "Setup",
           "items": [
+            "contributing-guide/setup/codespaces",
             "contributing-guide/setup/macos",
             "contributing-guide/setup/docker",
             "contributing-guide/setup/ubuntu",
@@ -421,4 +422,4 @@
       ]
     }
   ]
-}
+}

docs/versioned_sidebars/version-2.19.0-sidebars.json

@@ -373,6 +373,7 @@
           "type": "category",
           "label": "Setup",
           "items": [
+            "contributing-guide/setup/codespaces",
             "contributing-guide/setup/macos",
             "contributing-guide/setup/docker",
             "contributing-guide/setup/ubuntu",

docs/versioned_sidebars/version-2.22.0-sidebars.json

@@ -373,6 +373,7 @@
           "type": "category",
           "label": "Setup",
           "items": [
+            "contributing-guide/setup/codespaces",
             "contributing-guide/setup/macos",
             "contributing-guide/setup/docker",
             "contributing-guide/setup/ubuntu",
@@ -422,4 +423,4 @@
       ]
     }
   ]
-}
+}