From 329b9658c0c1a6b08fb673bd2f2d8495d7181070 Mon Sep 17 00:00:00 2001 From: Shubhendra Date: Tue, 31 Oct 2023 16:20:45 +0530 Subject: [PATCH 1/4] [doc]codespaces guide --- .../contributing-guide/setup/codespaces.md | 118 ++++++++++++++++++ docs/sidebars.js | 1 + .../contributing-guide/setup/codespaces.md | 118 ++++++++++++++++++ .../contributing-guide/setup/codespaces.md | 118 ++++++++++++++++++ .../contributing-guide/setup/codespaces.md | 118 ++++++++++++++++++ .../contributing-guide/setup/codespaces.md | 118 ++++++++++++++++++ .../contributing-guide/setup/codespaces.md | 118 ++++++++++++++++++ .../contributing-guide/setup/codespaces.md | 118 ++++++++++++++++++ .../version-2.15.0-sidebars.json | 1 + .../version-2.16.0-sidebars.json | 1 + .../version-2.17.0-sidebars.json | 1 + .../version-2.18.0-sidebars.json | 3 +- .../version-2.19.0-sidebars.json | 1 + .../version-2.22.0-sidebars.json | 3 +- 14 files changed, 835 insertions(+), 2 deletions(-) create mode 100644 docs/docs/contributing-guide/setup/codespaces.md create mode 100644 docs/versioned_docs/version-2.15.0/contributing-guide/setup/codespaces.md create mode 100644 docs/versioned_docs/version-2.16.0/contributing-guide/setup/codespaces.md create mode 100644 docs/versioned_docs/version-2.17.0/contributing-guide/setup/codespaces.md create mode 100644 docs/versioned_docs/version-2.18.0/contributing-guide/setup/codespaces.md create mode 100644 docs/versioned_docs/version-2.19.0/contributing-guide/setup/codespaces.md create mode 100644 docs/versioned_docs/version-2.22.0/contributing-guide/setup/codespaces.md diff --git a/docs/docs/contributing-guide/setup/codespaces.md b/docs/docs/contributing-guide/setup/codespaces.md new file mode 100644 index 0000000000..bfc2d53219 --- /dev/null +++ b/docs/docs/contributing-guide/setup/codespaces.md @@ -0,0 +1,118 @@ +--- +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: + +`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) + +``` +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 +``` + + +### 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:///apps/tooljet` \ No newline at end of file diff --git a/docs/sidebars.js b/docs/sidebars.js index ab94cdd29f..cdf308776d 100644 --- a/docs/sidebars.js +++ b/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', diff --git a/docs/versioned_docs/version-2.15.0/contributing-guide/setup/codespaces.md b/docs/versioned_docs/version-2.15.0/contributing-guide/setup/codespaces.md new file mode 100644 index 0000000000..bfc2d53219 --- /dev/null +++ b/docs/versioned_docs/version-2.15.0/contributing-guide/setup/codespaces.md @@ -0,0 +1,118 @@ +--- +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: + +`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) + +``` +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 +``` + + +### 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:///apps/tooljet` \ No newline at end of file diff --git a/docs/versioned_docs/version-2.16.0/contributing-guide/setup/codespaces.md b/docs/versioned_docs/version-2.16.0/contributing-guide/setup/codespaces.md new file mode 100644 index 0000000000..bfc2d53219 --- /dev/null +++ b/docs/versioned_docs/version-2.16.0/contributing-guide/setup/codespaces.md @@ -0,0 +1,118 @@ +--- +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: + +`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) + +``` +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 +``` + + +### 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:///apps/tooljet` \ No newline at end of file diff --git a/docs/versioned_docs/version-2.17.0/contributing-guide/setup/codespaces.md b/docs/versioned_docs/version-2.17.0/contributing-guide/setup/codespaces.md new file mode 100644 index 0000000000..bfc2d53219 --- /dev/null +++ b/docs/versioned_docs/version-2.17.0/contributing-guide/setup/codespaces.md @@ -0,0 +1,118 @@ +--- +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: + +`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) + +``` +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 +``` + + +### 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:///apps/tooljet` \ No newline at end of file diff --git a/docs/versioned_docs/version-2.18.0/contributing-guide/setup/codespaces.md b/docs/versioned_docs/version-2.18.0/contributing-guide/setup/codespaces.md new file mode 100644 index 0000000000..bfc2d53219 --- /dev/null +++ b/docs/versioned_docs/version-2.18.0/contributing-guide/setup/codespaces.md @@ -0,0 +1,118 @@ +--- +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: + +`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) + +``` +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 +``` + + +### 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:///apps/tooljet` \ No newline at end of file diff --git a/docs/versioned_docs/version-2.19.0/contributing-guide/setup/codespaces.md b/docs/versioned_docs/version-2.19.0/contributing-guide/setup/codespaces.md new file mode 100644 index 0000000000..bfc2d53219 --- /dev/null +++ b/docs/versioned_docs/version-2.19.0/contributing-guide/setup/codespaces.md @@ -0,0 +1,118 @@ +--- +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: + +`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) + +``` +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 +``` + + +### 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:///apps/tooljet` \ No newline at end of file diff --git a/docs/versioned_docs/version-2.22.0/contributing-guide/setup/codespaces.md b/docs/versioned_docs/version-2.22.0/contributing-guide/setup/codespaces.md new file mode 100644 index 0000000000..bfc2d53219 --- /dev/null +++ b/docs/versioned_docs/version-2.22.0/contributing-guide/setup/codespaces.md @@ -0,0 +1,118 @@ +--- +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: + +`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) + +``` +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 +``` + + +### 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:///apps/tooljet` \ No newline at end of file diff --git a/docs/versioned_sidebars/version-2.15.0-sidebars.json b/docs/versioned_sidebars/version-2.15.0-sidebars.json index 84cf3e94b2..be4cbea4be 100644 --- a/docs/versioned_sidebars/version-2.15.0-sidebars.json +++ b/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", diff --git a/docs/versioned_sidebars/version-2.16.0-sidebars.json b/docs/versioned_sidebars/version-2.16.0-sidebars.json index d3dc03521e..efcf1d8760 100644 --- a/docs/versioned_sidebars/version-2.16.0-sidebars.json +++ b/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", diff --git a/docs/versioned_sidebars/version-2.17.0-sidebars.json b/docs/versioned_sidebars/version-2.17.0-sidebars.json index c4aa240d9a..4e6b671de1 100644 --- a/docs/versioned_sidebars/version-2.17.0-sidebars.json +++ b/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", diff --git a/docs/versioned_sidebars/version-2.18.0-sidebars.json b/docs/versioned_sidebars/version-2.18.0-sidebars.json index 393cfcb9bb..b94aa3ff24 100644 --- a/docs/versioned_sidebars/version-2.18.0-sidebars.json +++ b/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 @@ ] } ] -} +} \ No newline at end of file diff --git a/docs/versioned_sidebars/version-2.19.0-sidebars.json b/docs/versioned_sidebars/version-2.19.0-sidebars.json index 66c63b0d4a..dcd5417d85 100644 --- a/docs/versioned_sidebars/version-2.19.0-sidebars.json +++ b/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", diff --git a/docs/versioned_sidebars/version-2.22.0-sidebars.json b/docs/versioned_sidebars/version-2.22.0-sidebars.json index 270805f7c5..be5dcec7a5 100644 --- a/docs/versioned_sidebars/version-2.22.0-sidebars.json +++ b/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 @@ ] } ] -} +} \ No newline at end of file From e897db5f11a2afc6e13e9de46cee0db71d91f9de Mon Sep 17 00:00:00 2001 From: Shubhendra Date: Tue, 31 Oct 2023 16:28:04 +0530 Subject: [PATCH 2/4] [doc]docker run command update --- docs/docs/setup/try-tooljet.md | 3 ++- docs/versioned_docs/version-1.x.x/setup/try-tooljet.md | 5 +++-- docs/versioned_docs/version-2.0.0/setup/try-tooljet.md | 3 ++- docs/versioned_docs/version-2.1.0/setup/try-tooljet.md | 3 ++- docs/versioned_docs/version-2.10.0/setup/try-tooljet.md | 3 ++- docs/versioned_docs/version-2.11.0/setup/try-tooljet.md | 3 ++- docs/versioned_docs/version-2.12.0/setup/try-tooljet.md | 4 ++-- docs/versioned_docs/version-2.13.0/setup/try-tooljet.md | 4 ++-- docs/versioned_docs/version-2.14.0/setup/try-tooljet.md | 4 ++-- docs/versioned_docs/version-2.15.0/setup/try-tooljet.md | 4 ++-- docs/versioned_docs/version-2.16.0/setup/try-tooljet.md | 4 ++-- docs/versioned_docs/version-2.17.0/setup/try-tooljet.md | 4 ++-- docs/versioned_docs/version-2.18.0/setup/try-tooljet.md | 4 ++-- docs/versioned_docs/version-2.19.0/setup/try-tooljet.md | 4 ++-- docs/versioned_docs/version-2.2.0/setup/try-tooljet.md | 4 +++- docs/versioned_docs/version-2.22.0/setup/try-tooljet.md | 4 ++-- docs/versioned_docs/version-2.3.0/setup/try-tooljet.md | 4 +++- docs/versioned_docs/version-2.4.0/setup/try-tooljet.md | 4 +++- docs/versioned_docs/version-2.5.0/setup/try-tooljet.md | 4 +++- docs/versioned_docs/version-2.6.0/setup/try-tooljet.md | 4 +++- docs/versioned_docs/version-2.7.0/setup/try-tooljet.md | 4 +++- docs/versioned_docs/version-2.8.0/setup/try-tooljet.md | 4 +++- docs/versioned_docs/version-2.9.0/setup/try-tooljet.md | 4 +++- docs/versioned_docs/version-2.9.4/setup/try-tooljet.md | 4 +++- 24 files changed, 58 insertions(+), 34 deletions(-) diff --git a/docs/docs/setup/try-tooljet.md b/docs/docs/setup/try-tooljet.md index eb60b5323a..ff2bc44904 100644 --- a/docs/docs/setup/try-tooljet.md +++ b/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 ``` diff --git a/docs/versioned_docs/version-1.x.x/setup/try-tooljet.md b/docs/versioned_docs/version-1.x.x/setup/try-tooljet.md index ed0173f004..6d379d672b 100644 --- a/docs/versioned_docs/version-1.x.x/setup/try-tooljet.md +++ b/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 ``` diff --git a/docs/versioned_docs/version-2.0.0/setup/try-tooljet.md b/docs/versioned_docs/version-2.0.0/setup/try-tooljet.md index 7ba26756aa..e2158d85fd 100644 --- a/docs/versioned_docs/version-2.0.0/setup/try-tooljet.md +++ b/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 ``` diff --git a/docs/versioned_docs/version-2.1.0/setup/try-tooljet.md b/docs/versioned_docs/version-2.1.0/setup/try-tooljet.md index 7ba26756aa..e2158d85fd 100644 --- a/docs/versioned_docs/version-2.1.0/setup/try-tooljet.md +++ b/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 ``` diff --git a/docs/versioned_docs/version-2.10.0/setup/try-tooljet.md b/docs/versioned_docs/version-2.10.0/setup/try-tooljet.md index 7ba26756aa..e2158d85fd 100644 --- a/docs/versioned_docs/version-2.10.0/setup/try-tooljet.md +++ b/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 ``` diff --git a/docs/versioned_docs/version-2.11.0/setup/try-tooljet.md b/docs/versioned_docs/version-2.11.0/setup/try-tooljet.md index 7ba26756aa..e2158d85fd 100644 --- a/docs/versioned_docs/version-2.11.0/setup/try-tooljet.md +++ b/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 ``` diff --git a/docs/versioned_docs/version-2.12.0/setup/try-tooljet.md b/docs/versioned_docs/version-2.12.0/setup/try-tooljet.md index eb60b5323a..59c9108cf2 100644 --- a/docs/versioned_docs/version-2.12.0/setup/try-tooljet.md +++ b/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. diff --git a/docs/versioned_docs/version-2.13.0/setup/try-tooljet.md b/docs/versioned_docs/version-2.13.0/setup/try-tooljet.md index eb60b5323a..59c9108cf2 100644 --- a/docs/versioned_docs/version-2.13.0/setup/try-tooljet.md +++ b/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. diff --git a/docs/versioned_docs/version-2.14.0/setup/try-tooljet.md b/docs/versioned_docs/version-2.14.0/setup/try-tooljet.md index eb60b5323a..59c9108cf2 100644 --- a/docs/versioned_docs/version-2.14.0/setup/try-tooljet.md +++ b/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. diff --git a/docs/versioned_docs/version-2.15.0/setup/try-tooljet.md b/docs/versioned_docs/version-2.15.0/setup/try-tooljet.md index eb60b5323a..59c9108cf2 100644 --- a/docs/versioned_docs/version-2.15.0/setup/try-tooljet.md +++ b/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. diff --git a/docs/versioned_docs/version-2.16.0/setup/try-tooljet.md b/docs/versioned_docs/version-2.16.0/setup/try-tooljet.md index eb60b5323a..59c9108cf2 100644 --- a/docs/versioned_docs/version-2.16.0/setup/try-tooljet.md +++ b/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. diff --git a/docs/versioned_docs/version-2.17.0/setup/try-tooljet.md b/docs/versioned_docs/version-2.17.0/setup/try-tooljet.md index eb60b5323a..59c9108cf2 100644 --- a/docs/versioned_docs/version-2.17.0/setup/try-tooljet.md +++ b/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. diff --git a/docs/versioned_docs/version-2.18.0/setup/try-tooljet.md b/docs/versioned_docs/version-2.18.0/setup/try-tooljet.md index eb60b5323a..59c9108cf2 100644 --- a/docs/versioned_docs/version-2.18.0/setup/try-tooljet.md +++ b/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. diff --git a/docs/versioned_docs/version-2.19.0/setup/try-tooljet.md b/docs/versioned_docs/version-2.19.0/setup/try-tooljet.md index eb60b5323a..59c9108cf2 100644 --- a/docs/versioned_docs/version-2.19.0/setup/try-tooljet.md +++ b/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. diff --git a/docs/versioned_docs/version-2.2.0/setup/try-tooljet.md b/docs/versioned_docs/version-2.2.0/setup/try-tooljet.md index 7ba26756aa..59c9108cf2 100644 --- a/docs/versioned_docs/version-2.2.0/setup/try-tooljet.md +++ b/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 ``` diff --git a/docs/versioned_docs/version-2.22.0/setup/try-tooljet.md b/docs/versioned_docs/version-2.22.0/setup/try-tooljet.md index eb60b5323a..59c9108cf2 100644 --- a/docs/versioned_docs/version-2.22.0/setup/try-tooljet.md +++ b/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. diff --git a/docs/versioned_docs/version-2.3.0/setup/try-tooljet.md b/docs/versioned_docs/version-2.3.0/setup/try-tooljet.md index 7ba26756aa..59c9108cf2 100644 --- a/docs/versioned_docs/version-2.3.0/setup/try-tooljet.md +++ b/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 ``` diff --git a/docs/versioned_docs/version-2.4.0/setup/try-tooljet.md b/docs/versioned_docs/version-2.4.0/setup/try-tooljet.md index 7ba26756aa..59c9108cf2 100644 --- a/docs/versioned_docs/version-2.4.0/setup/try-tooljet.md +++ b/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 ``` diff --git a/docs/versioned_docs/version-2.5.0/setup/try-tooljet.md b/docs/versioned_docs/version-2.5.0/setup/try-tooljet.md index 7ba26756aa..59c9108cf2 100644 --- a/docs/versioned_docs/version-2.5.0/setup/try-tooljet.md +++ b/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 ``` diff --git a/docs/versioned_docs/version-2.6.0/setup/try-tooljet.md b/docs/versioned_docs/version-2.6.0/setup/try-tooljet.md index 7ba26756aa..59c9108cf2 100644 --- a/docs/versioned_docs/version-2.6.0/setup/try-tooljet.md +++ b/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 ``` diff --git a/docs/versioned_docs/version-2.7.0/setup/try-tooljet.md b/docs/versioned_docs/version-2.7.0/setup/try-tooljet.md index 7ba26756aa..59c9108cf2 100644 --- a/docs/versioned_docs/version-2.7.0/setup/try-tooljet.md +++ b/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 ``` diff --git a/docs/versioned_docs/version-2.8.0/setup/try-tooljet.md b/docs/versioned_docs/version-2.8.0/setup/try-tooljet.md index 7ba26756aa..59c9108cf2 100644 --- a/docs/versioned_docs/version-2.8.0/setup/try-tooljet.md +++ b/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 ``` diff --git a/docs/versioned_docs/version-2.9.0/setup/try-tooljet.md b/docs/versioned_docs/version-2.9.0/setup/try-tooljet.md index 7ba26756aa..59c9108cf2 100644 --- a/docs/versioned_docs/version-2.9.0/setup/try-tooljet.md +++ b/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 ``` diff --git a/docs/versioned_docs/version-2.9.4/setup/try-tooljet.md b/docs/versioned_docs/version-2.9.4/setup/try-tooljet.md index 7ba26756aa..59c9108cf2 100644 --- a/docs/versioned_docs/version-2.9.4/setup/try-tooljet.md +++ b/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 ``` From 73c4c17ad49c089a29f2107cdec379ca2ea26f83 Mon Sep 17 00:00:00 2001 From: Shubhendra Date: Tue, 31 Oct 2023 16:34:12 +0530 Subject: [PATCH 3/4] [doc]ec2 update --- docs/docs/setup/ec2.md | 7 +++++++ docs/versioned_docs/version-2.15.0/setup/ec2.md | 7 +++++++ docs/versioned_docs/version-2.16.0/setup/ec2.md | 7 +++++++ docs/versioned_docs/version-2.17.0/setup/ec2.md | 7 +++++++ docs/versioned_docs/version-2.18.0/setup/ec2.md | 7 +++++++ docs/versioned_docs/version-2.19.0/setup/ec2.md | 7 +++++++ docs/versioned_docs/version-2.22.0/setup/ec2.md | 7 +++++++ 7 files changed, 49 insertions(+) diff --git a/docs/docs/setup/ec2.md b/docs/docs/setup/ec2.md index 662b4f2d56..e4cc244db9 100644 --- a/docs/docs/setup/ec2.md +++ b/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. diff --git a/docs/versioned_docs/version-2.15.0/setup/ec2.md b/docs/versioned_docs/version-2.15.0/setup/ec2.md index 662b4f2d56..e4cc244db9 100644 --- a/docs/versioned_docs/version-2.15.0/setup/ec2.md +++ b/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. diff --git a/docs/versioned_docs/version-2.16.0/setup/ec2.md b/docs/versioned_docs/version-2.16.0/setup/ec2.md index 662b4f2d56..e4cc244db9 100644 --- a/docs/versioned_docs/version-2.16.0/setup/ec2.md +++ b/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. diff --git a/docs/versioned_docs/version-2.17.0/setup/ec2.md b/docs/versioned_docs/version-2.17.0/setup/ec2.md index 662b4f2d56..e4cc244db9 100644 --- a/docs/versioned_docs/version-2.17.0/setup/ec2.md +++ b/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. diff --git a/docs/versioned_docs/version-2.18.0/setup/ec2.md b/docs/versioned_docs/version-2.18.0/setup/ec2.md index 662b4f2d56..e4cc244db9 100644 --- a/docs/versioned_docs/version-2.18.0/setup/ec2.md +++ b/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. diff --git a/docs/versioned_docs/version-2.19.0/setup/ec2.md b/docs/versioned_docs/version-2.19.0/setup/ec2.md index 662b4f2d56..e4cc244db9 100644 --- a/docs/versioned_docs/version-2.19.0/setup/ec2.md +++ b/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. diff --git a/docs/versioned_docs/version-2.22.0/setup/ec2.md b/docs/versioned_docs/version-2.22.0/setup/ec2.md index 662b4f2d56..e4cc244db9 100644 --- a/docs/versioned_docs/version-2.22.0/setup/ec2.md +++ b/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. From e744b2ee2fe232b3438f3df80eb8c2638763cce9 Mon Sep 17 00:00:00 2001 From: Shubhendra Date: Thu, 2 Nov 2023 16:02:44 +0530 Subject: [PATCH 4/4] minor update --- docs/docs/contributing-guide/setup/codespaces.md | 9 ++++----- .../contributing-guide/setup/codespaces.md | 9 ++++----- .../contributing-guide/setup/codespaces.md | 9 ++++----- .../contributing-guide/setup/codespaces.md | 9 ++++----- .../contributing-guide/setup/codespaces.md | 9 ++++----- .../contributing-guide/setup/codespaces.md | 9 ++++----- .../contributing-guide/setup/codespaces.md | 9 ++++----- 7 files changed, 28 insertions(+), 35 deletions(-) diff --git a/docs/docs/contributing-guide/setup/codespaces.md b/docs/docs/contributing-guide/setup/codespaces.md index bfc2d53219..1204d71f63 100644 --- a/docs/docs/contributing-guide/setup/codespaces.md +++ b/docs/docs/contributing-guide/setup/codespaces.md @@ -53,11 +53,7 @@ sudo -u postgres psql 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: - -`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) +**For basic set-up you add the below env variables:** ``` TOOLJET_HOST=http://localhost:3000 @@ -81,6 +77,9 @@ 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 diff --git a/docs/versioned_docs/version-2.15.0/contributing-guide/setup/codespaces.md b/docs/versioned_docs/version-2.15.0/contributing-guide/setup/codespaces.md index bfc2d53219..1204d71f63 100644 --- a/docs/versioned_docs/version-2.15.0/contributing-guide/setup/codespaces.md +++ b/docs/versioned_docs/version-2.15.0/contributing-guide/setup/codespaces.md @@ -53,11 +53,7 @@ sudo -u postgres psql 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: - -`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) +**For basic set-up you add the below env variables:** ``` TOOLJET_HOST=http://localhost:3000 @@ -81,6 +77,9 @@ 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 diff --git a/docs/versioned_docs/version-2.16.0/contributing-guide/setup/codespaces.md b/docs/versioned_docs/version-2.16.0/contributing-guide/setup/codespaces.md index bfc2d53219..1204d71f63 100644 --- a/docs/versioned_docs/version-2.16.0/contributing-guide/setup/codespaces.md +++ b/docs/versioned_docs/version-2.16.0/contributing-guide/setup/codespaces.md @@ -53,11 +53,7 @@ sudo -u postgres psql 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: - -`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) +**For basic set-up you add the below env variables:** ``` TOOLJET_HOST=http://localhost:3000 @@ -81,6 +77,9 @@ 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 diff --git a/docs/versioned_docs/version-2.17.0/contributing-guide/setup/codespaces.md b/docs/versioned_docs/version-2.17.0/contributing-guide/setup/codespaces.md index bfc2d53219..1204d71f63 100644 --- a/docs/versioned_docs/version-2.17.0/contributing-guide/setup/codespaces.md +++ b/docs/versioned_docs/version-2.17.0/contributing-guide/setup/codespaces.md @@ -53,11 +53,7 @@ sudo -u postgres psql 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: - -`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) +**For basic set-up you add the below env variables:** ``` TOOLJET_HOST=http://localhost:3000 @@ -81,6 +77,9 @@ 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 diff --git a/docs/versioned_docs/version-2.18.0/contributing-guide/setup/codespaces.md b/docs/versioned_docs/version-2.18.0/contributing-guide/setup/codespaces.md index bfc2d53219..1204d71f63 100644 --- a/docs/versioned_docs/version-2.18.0/contributing-guide/setup/codespaces.md +++ b/docs/versioned_docs/version-2.18.0/contributing-guide/setup/codespaces.md @@ -53,11 +53,7 @@ sudo -u postgres psql 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: - -`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) +**For basic set-up you add the below env variables:** ``` TOOLJET_HOST=http://localhost:3000 @@ -81,6 +77,9 @@ 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 diff --git a/docs/versioned_docs/version-2.19.0/contributing-guide/setup/codespaces.md b/docs/versioned_docs/version-2.19.0/contributing-guide/setup/codespaces.md index bfc2d53219..1204d71f63 100644 --- a/docs/versioned_docs/version-2.19.0/contributing-guide/setup/codespaces.md +++ b/docs/versioned_docs/version-2.19.0/contributing-guide/setup/codespaces.md @@ -53,11 +53,7 @@ sudo -u postgres psql 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: - -`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) +**For basic set-up you add the below env variables:** ``` TOOLJET_HOST=http://localhost:3000 @@ -81,6 +77,9 @@ 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 diff --git a/docs/versioned_docs/version-2.22.0/contributing-guide/setup/codespaces.md b/docs/versioned_docs/version-2.22.0/contributing-guide/setup/codespaces.md index bfc2d53219..1204d71f63 100644 --- a/docs/versioned_docs/version-2.22.0/contributing-guide/setup/codespaces.md +++ b/docs/versioned_docs/version-2.22.0/contributing-guide/setup/codespaces.md @@ -53,11 +53,7 @@ sudo -u postgres psql 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: - -`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) +**For basic set-up you add the below env variables:** ``` TOOLJET_HOST=http://localhost:3000 @@ -81,6 +77,9 @@ 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