From 252a84cb0da467a45009717b1d76bad59f422996 Mon Sep 17 00:00:00 2001 From: Sumit Kumar Date: Wed, 28 Oct 2020 12:47:18 +0530 Subject: [PATCH 01/20] Update server and client setup guide. (#1437) 1. Add Linux specific requirements. 2. Add debug info for common build errors. 3. Correct build step or any other statement wherever required. 4. For more info please see the attachment here: https://github.com/appsmithorg/appsmith/issues/1437 --- contributions/ServerSetup.md | 1 + 1 file changed, 1 insertion(+) diff --git a/contributions/ServerSetup.md b/contributions/ServerSetup.md index 70b4df933b..022b514076 100644 --- a/contributions/ServerSetup.md +++ b/contributions/ServerSetup.md @@ -37,6 +37,7 @@ This command creates a `.env` file in the `app/server` folder. All run scripts p ``` ./build.sh ``` +NOTE: On Ubuntu Linux environment docker needs root privilege, hence ./build.sh script needs to be run with roon privilege as well. For more info, please see: https://docs.docker.com/engine/install/linux-postinstall/#:~:text=The%20Docker%20daemon%20always%20runs,members%20of%20the%20docker%20group This command will create a `dist` folder which contains the final packaged jar along with multiple jars for the binaries for plugins as well. From 0689ff48732bb1e45ff3dc934dd6011419923262 Mon Sep 17 00:00:00 2001 From: Sumit Kumar Date: Wed, 28 Oct 2020 12:47:18 +0530 Subject: [PATCH 02/20] Update server and client setup guide. (#1437) 1. Add Linux specific requirements. 2. Add debug info for common build errors. 3. Correct build step or any other statement wherever required. 4. For more info please see the attachment here: https://github.com/appsmithorg/appsmith/issues/1437 --- contributions/ServerSetup.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/contributions/ServerSetup.md b/contributions/ServerSetup.md index 70b4df933b..e1f585d064 100644 --- a/contributions/ServerSetup.md +++ b/contributions/ServerSetup.md @@ -37,6 +37,8 @@ This command creates a `.env` file in the `app/server` folder. All run scripts p ``` ./build.sh ``` +Note: 1. On Ubuntu Linux environment docker needs root privilege, hence ./build.sh script needs to be run with roon privilege as well. + 2. If the volume containing docker's data root path (macOS: ~/Library/Containers/com.docker.docker/Data/vms/0/, Ubuntu: /var/lib/docker/) has less than 2 GB space free, then the script may fail with the following error: Check failed: Docker environment should have more than 2GB free disk space. There are two ways to resolve this issue (1) free up space (2) change docker's data root path. This command will create a `dist` folder which contains the final packaged jar along with multiple jars for the binaries for plugins as well. @@ -50,7 +52,7 @@ By default, the server will start on port 8080. 7. When the server starts, it automatically runs migrations on MongoDB and will populate it with some initial required data. -8. You can check the status of the server by hitting the endpoint: [http://localhost:8080](http://localhost:8080) on your browser. By default you should see a blank page. +8. You can check the status of the server by hitting the endpoint: [http://localhost:8080](http://localhost:8080) on your browser. By default you should see a HTTP 401 error. ## Setting up a local MongoDB @@ -74,4 +76,9 @@ The following command can bring up a Redis docker instance locally. docker run -p 127.0.0.1:6379:6379 --name appsmith-redis redis ``` +## Need Help +If you facing issues while doing the setup: +(1) Please re-read all the steps and make sure you follow all instructions. +(2) In case step (1) does not resolve your issue, please send an email to support@appsmith.com . We will be happy to help you. + When using this command, the value of `APPSMITH_REDIS_URI` should be set to `redis://localhost:6379`. From 7c190002d01191141c92fb6ffc519539155ac0ef Mon Sep 17 00:00:00 2001 From: Sumit Kumar Date: Wed, 28 Oct 2020 16:14:15 +0530 Subject: [PATCH 03/20] Update ServerSetup.md --- contributions/ServerSetup.md | 13 +++++++------ 1 file changed, 7 insertions(+), 6 deletions(-) diff --git a/contributions/ServerSetup.md b/contributions/ServerSetup.md index e1f585d064..f4da589f51 100644 --- a/contributions/ServerSetup.md +++ b/contributions/ServerSetup.md @@ -37,8 +37,9 @@ This command creates a `.env` file in the `app/server` folder. All run scripts p ``` ./build.sh ``` -Note: 1. On Ubuntu Linux environment docker needs root privilege, hence ./build.sh script needs to be run with roon privilege as well. - 2. If the volume containing docker's data root path (macOS: ~/Library/Containers/com.docker.docker/Data/vms/0/, Ubuntu: /var/lib/docker/) has less than 2 GB space free, then the script may fail with the following error: Check failed: Docker environment should have more than 2GB free disk space. There are two ways to resolve this issue (1) free up space (2) change docker's data root path. +Note: +- On Ubuntu Linux environment docker needs root privilege, hence ./build.sh script needs to be run with roon privilege as well. +- If the volume containing docker's data root path (macOS: ~/Library/Containers/com.docker.docker/Data/vms/0/, Ubuntu: /var/lib/docker/) has less than 2 GB space free, then the script may fail with the following error: Check failed: Docker environment should have more than 2GB free disk space. There are two ways to resolve this issue (1) free up space (2) change docker's data root path. This command will create a `dist` folder which contains the final packaged jar along with multiple jars for the binaries for plugins as well. @@ -76,9 +77,9 @@ The following command can bring up a Redis docker instance locally. docker run -p 127.0.0.1:6379:6379 --name appsmith-redis redis ``` +When using this command, the value of `APPSMITH_REDIS_URI` should be set to `redis://localhost:6379`. + ## Need Help If you facing issues while doing the setup: -(1) Please re-read all the steps and make sure you follow all instructions. -(2) In case step (1) does not resolve your issue, please send an email to support@appsmith.com . We will be happy to help you. - -When using this command, the value of `APPSMITH_REDIS_URI` should be set to `redis://localhost:6379`. +- Please re-read all the steps and make sure you follow all instructions. +- In case step (1) does not resolve your issue, please send an email to support@appsmith.com . We will be happy to help you. From 149f90c031f0407720d36dc7f802cee020967aab Mon Sep 17 00:00:00 2001 From: Sumit Kumar Date: Wed, 28 Oct 2020 17:46:44 +0530 Subject: [PATCH 04/20] Update server and client setup guide. (#1437) 1. Add Linux specific requirements. 2. Add debug info for common build errors. 3. Correct build step or any other statement wherever required. 4. For more info please see the attachment here: https://github.com/appsmithorg/appsmith/issues/1437 --- contributions/ClientSetup.md | 29 ++++++++++++++++++++++++++--- 1 file changed, 26 insertions(+), 3 deletions(-) diff --git a/contributions/ClientSetup.md b/contributions/ClientSetup.md index 91719f74d2..4aae0ee670 100644 --- a/contributions/ClientSetup.md +++ b/contributions/ClientSetup.md @@ -27,12 +27,23 @@ This command will create 2 files in the `docker/` directory: ```bash echo "127.0.0.1 dev.appsmith.com" | sudo tee -a /etc/hosts ``` +Note: +- Please be careful when copying the above string as space between the ip and the string goes missing sometimes. +- Please check that the string has been copied properly by running +``` +cat /etc/hosts | grep appsmith +``` 3. Run the script `start-https.sh` in order to start the nginx container that will proxy the frontend code on your local system. ```bash cd app/client ./start-https.sh ``` +Note: +- If you see the following error: `Please populate the .env at the root of the project and run again`, then run the following cmd and try again: +``` +cp ../../.env.example ../../.env +``` #### WSL (Windows Subsystem for Linux) @@ -45,6 +56,11 @@ cd app/client ### Steps to build & run the code: 1. Run `yarn` 2. Run `yarn start` +Note: +- On Ubuntu Linux platform, please run the following cmd before step 2 above: +``` +echo fs.inotify.max_user_watches=524288 | sudo tee -a /etc/sysctl.conf && sudo sysctl -p +``` 🎉 Your Appsmith client is now running on https://dev.appsmith.com. @@ -59,11 +75,12 @@ node versions to be used in different projects. Check below for installation and 2. In the root of the project, run `nvm use 10.16.3` or `fnm use 10.16.3`. #### If you would like to hit a different Appsmith server: -- Change the API endpoint in the Nginx configuration files (`app/client/docker/templates/nginx-linux.conf.template` or `app/client/docker/templates/nginx-mac.conf.template`). +- Change the API endpoint in the Nginx configuration files (`app/client/docker/templates/nginx-linux.conf.template` or `app/client/docker/templates/nginx-mac.conf.template`). By default it points to the cloud hosted server https://release-api.appsmith.com. If you want it to point to your local instance, then replace all such ip instances with https://localhost:8080 - Run `start-https.sh` script again. - Run -```bash -REACT_APP_ENVIRONMENT=DEVELOPMENT HOST=dev.appsmith.com craco start +``` +yarn +yarn start ``` @@ -74,3 +91,9 @@ REACT_APP_ENVIRONMENT=DEVELOPMENT HOST=dev.appsmith.com craco start 3. Generate the certificates manually via `mkcert`. Check the command in `start-https-server.sh` file. 4. Change the value of the certificate location for keys `ssl_certificate` & `ssl_certificate_key` to the place where these certificates were generated. 5. If you ran `./start-https`, but containers failed to start (you have to check with `docker ps` since it fails silently). Some Linux distros (`Ubuntu` for example) have installed and running `apache2` webserver on port `80`. This can result in `Address already in use` error (you can check with `docker logs wildcard-nginx`). Simple solution for this is simply turning it off temporarily with `sudo systemctl stop apache2`. After that just run `./start-https` again. + + +## Need Help +If you facing issues while doing the setup: +- Please re-read all the steps and make sure you follow all instructions. +- In case step (1) does not resolve your issue, please send an email to support@appsmith.com . We will be happy to help you. From 5d9eceaa0606f12b227b2d9c6fe4268aa9ab11e0 Mon Sep 17 00:00:00 2001 From: Sumit Kumar Date: Wed, 28 Oct 2020 17:46:44 +0530 Subject: [PATCH 05/20] Update server and client setup guide. (#1437) 1. Add Linux specific requirements. 2. Add debug info for common build errors. 3. Correct build step or any other statement wherever required. 4. For more info please see the attachment here: https://github.com/appsmithorg/appsmith/issues/1437 --- contributions/ClientSetup.md | 29 ++++++++++++++++++++++++++--- contributions/ServerSetup.md | 4 ++-- 2 files changed, 28 insertions(+), 5 deletions(-) diff --git a/contributions/ClientSetup.md b/contributions/ClientSetup.md index 91719f74d2..9d3fd1a435 100644 --- a/contributions/ClientSetup.md +++ b/contributions/ClientSetup.md @@ -27,12 +27,23 @@ This command will create 2 files in the `docker/` directory: ```bash echo "127.0.0.1 dev.appsmith.com" | sudo tee -a /etc/hosts ``` +Note: +- Please be careful when copying the above string as space between the ip and the string goes missing sometimes. +- Please check that the string has been copied properly by running +``` +cat /etc/hosts | grep appsmith +``` 3. Run the script `start-https.sh` in order to start the nginx container that will proxy the frontend code on your local system. ```bash cd app/client ./start-https.sh ``` +Note: +- If you see the following error: `Please populate the .env at the root of the project and run again`, then run the following cmd and try again: +``` +cp ../../.env.example ../../.env +``` #### WSL (Windows Subsystem for Linux) @@ -45,6 +56,11 @@ cd app/client ### Steps to build & run the code: 1. Run `yarn` 2. Run `yarn start` +Note: +- On Ubuntu Linux platform, please run the following cmd before step 2 above: +``` +echo fs.inotify.max_user_watches=524288 | sudo tee -a /etc/sysctl.conf && sudo sysctl -p +``` 🎉 Your Appsmith client is now running on https://dev.appsmith.com. @@ -59,11 +75,12 @@ node versions to be used in different projects. Check below for installation and 2. In the root of the project, run `nvm use 10.16.3` or `fnm use 10.16.3`. #### If you would like to hit a different Appsmith server: -- Change the API endpoint in the Nginx configuration files (`app/client/docker/templates/nginx-linux.conf.template` or `app/client/docker/templates/nginx-mac.conf.template`). +- Change the API endpoint in the Nginx configuration files (`app/client/docker/templates/nginx-linux.conf.template` or `app/client/docker/templates/nginx-mac.conf.template`). By default it points to the cloud hosted server https://release-api.appsmith.com. If you want it to point to your local instance, then replace all such ip instances with https://localhost:8080 - Run `start-https.sh` script again. - Run -```bash -REACT_APP_ENVIRONMENT=DEVELOPMENT HOST=dev.appsmith.com craco start +``` +yarn +yarn start ``` @@ -74,3 +91,9 @@ REACT_APP_ENVIRONMENT=DEVELOPMENT HOST=dev.appsmith.com craco start 3. Generate the certificates manually via `mkcert`. Check the command in `start-https-server.sh` file. 4. Change the value of the certificate location for keys `ssl_certificate` & `ssl_certificate_key` to the place where these certificates were generated. 5. If you ran `./start-https`, but containers failed to start (you have to check with `docker ps` since it fails silently). Some Linux distros (`Ubuntu` for example) have installed and running `apache2` webserver on port `80`. This can result in `Address already in use` error (you can check with `docker logs wildcard-nginx`). Simple solution for this is simply turning it off temporarily with `sudo systemctl stop apache2`. After that just run `./start-https` again. + + +## Need Assistance +If you facing issues while doing the setup: +- Please re-read all the steps and make sure you follow all instructions. +- In case step (1) does not resolve your issue, please send an email to support@appsmith.com . Team Appsmith will be happy to help you. diff --git a/contributions/ServerSetup.md b/contributions/ServerSetup.md index f4da589f51..cfddb2cbad 100644 --- a/contributions/ServerSetup.md +++ b/contributions/ServerSetup.md @@ -79,7 +79,7 @@ docker run -p 127.0.0.1:6379:6379 --name appsmith-redis redis When using this command, the value of `APPSMITH_REDIS_URI` should be set to `redis://localhost:6379`. -## Need Help +## Need Assistance If you facing issues while doing the setup: - Please re-read all the steps and make sure you follow all instructions. -- In case step (1) does not resolve your issue, please send an email to support@appsmith.com . We will be happy to help you. +- In case step (1) does not resolve your issue, please send an email to support@appsmith.com . Team Appsmith will be happy to help you. From 36973269b8869a030c5b67f79b9e85ec8c113b4c Mon Sep 17 00:00:00 2001 From: Sumit Kumar Date: Wed, 28 Oct 2020 18:00:05 +0530 Subject: [PATCH 06/20] Update server and client setup guide. (#1437) 1. Add Linux specific requirements. 2. Add debug info for common build errors. 3. Correct build step or any other statement wherever required. 4. For more info please see the attachment here: https://github.com/appsmithorg/appsmith/issues/1437 --- contributions/ClientSetup.md | 2 +- contributions/ServerSetup.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/contributions/ClientSetup.md b/contributions/ClientSetup.md index 9d3fd1a435..058520cd7e 100644 --- a/contributions/ClientSetup.md +++ b/contributions/ClientSetup.md @@ -94,6 +94,6 @@ yarn start ## Need Assistance -If you facing issues while doing the setup: +If you are unable to resolve any issue while doing the setup: - Please re-read all the steps and make sure you follow all instructions. - In case step (1) does not resolve your issue, please send an email to support@appsmith.com . Team Appsmith will be happy to help you. diff --git a/contributions/ServerSetup.md b/contributions/ServerSetup.md index cfddb2cbad..c60102df96 100644 --- a/contributions/ServerSetup.md +++ b/contributions/ServerSetup.md @@ -80,6 +80,6 @@ docker run -p 127.0.0.1:6379:6379 --name appsmith-redis redis When using this command, the value of `APPSMITH_REDIS_URI` should be set to `redis://localhost:6379`. ## Need Assistance -If you facing issues while doing the setup: +If you are unable to resolve any issue while doing the setup: - Please re-read all the steps and make sure you follow all instructions. - In case step (1) does not resolve your issue, please send an email to support@appsmith.com . Team Appsmith will be happy to help you. From dde3f11658ffc9603f553fc62459359bfacd2888 Mon Sep 17 00:00:00 2001 From: Sumit Kumar Date: Wed, 28 Oct 2020 18:00:05 +0530 Subject: [PATCH 07/20] Update server and client setup guide. (#1437) 1. Add Linux specific requirements. 2. Add debug info for common build errors. 3. Correct build step or any other statement wherever required. 4. For more info please see the attachment here: https://github.com/appsmithorg/appsmith/issues/1437 --- contributions/ClientSetup.md | 2 +- contributions/ServerSetup.md | 6 +++++- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/contributions/ClientSetup.md b/contributions/ClientSetup.md index 9d3fd1a435..058520cd7e 100644 --- a/contributions/ClientSetup.md +++ b/contributions/ClientSetup.md @@ -94,6 +94,6 @@ yarn start ## Need Assistance -If you facing issues while doing the setup: +If you are unable to resolve any issue while doing the setup: - Please re-read all the steps and make sure you follow all instructions. - In case step (1) does not resolve your issue, please send an email to support@appsmith.com . Team Appsmith will be happy to help you. diff --git a/contributions/ServerSetup.md b/contributions/ServerSetup.md index cfddb2cbad..e873a3ac2e 100644 --- a/contributions/ServerSetup.md +++ b/contributions/ServerSetup.md @@ -39,6 +39,10 @@ This command creates a `.env` file in the `app/server` folder. All run scripts p ``` Note: - On Ubuntu Linux environment docker needs root privilege, hence ./build.sh script needs to be run with roon privilege as well. +- On Ubuntu Linux environment, the script may not be able to read .env file, so it is advised that you run the cmd like: +``` +sudo APPSMITH_MONGODB_URI="mongodb://localhost:27017/appsmith" APPSMITH_REDIS_URL="redis://127.0.0.1:6379" APPSMITH_MAIL_ENABLED=false APPSMITH_ENCRYPTION_PASSWORD=abcd APPSMITH_ENCRYPTION_SALT=abcd ./buid.sh +``` - If the volume containing docker's data root path (macOS: ~/Library/Containers/com.docker.docker/Data/vms/0/, Ubuntu: /var/lib/docker/) has less than 2 GB space free, then the script may fail with the following error: Check failed: Docker environment should have more than 2GB free disk space. There are two ways to resolve this issue (1) free up space (2) change docker's data root path. This command will create a `dist` folder which contains the final packaged jar along with multiple jars for the binaries for plugins as well. @@ -80,6 +84,6 @@ docker run -p 127.0.0.1:6379:6379 --name appsmith-redis redis When using this command, the value of `APPSMITH_REDIS_URI` should be set to `redis://localhost:6379`. ## Need Assistance -If you facing issues while doing the setup: +If you are unable to resolve any issue while doing the setup: - Please re-read all the steps and make sure you follow all instructions. - In case step (1) does not resolve your issue, please send an email to support@appsmith.com . Team Appsmith will be happy to help you. From cf64ad3502cea383fe80012cb39b86d7b8a81cb0 Mon Sep 17 00:00:00 2001 From: Sumit Kumar Date: Wed, 28 Oct 2020 18:13:37 +0530 Subject: [PATCH 08/20] Update server and client setup guide. (#1437) 1. Add Linux specific requirements. 2. Add debug info for common build errors. 3. Correct build step or any other statement wherever required. 4. For more info please see the attachment here: https://github.com/appsmithorg/appsmith/issues/1437 --- contributions/ServerSetup.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/contributions/ServerSetup.md b/contributions/ServerSetup.md index e873a3ac2e..460ef8252f 100644 --- a/contributions/ServerSetup.md +++ b/contributions/ServerSetup.md @@ -38,7 +38,7 @@ This command creates a `.env` file in the `app/server` folder. All run scripts p ./build.sh ``` Note: -- On Ubuntu Linux environment docker needs root privilege, hence ./build.sh script needs to be run with roon privilege as well. +- On Ubuntu Linux environment docker needs root privilege, hence ./build.sh script needs to be run with root privilege as well. - On Ubuntu Linux environment, the script may not be able to read .env file, so it is advised that you run the cmd like: ``` sudo APPSMITH_MONGODB_URI="mongodb://localhost:27017/appsmith" APPSMITH_REDIS_URL="redis://127.0.0.1:6379" APPSMITH_MAIL_ENABLED=false APPSMITH_ENCRYPTION_PASSWORD=abcd APPSMITH_ENCRYPTION_SALT=abcd ./buid.sh From 1437d4a9e8a5bbbf374ab80bd5fde1cc0136f745 Mon Sep 17 00:00:00 2001 From: Sumit Kumar Date: Wed, 28 Oct 2020 18:13:37 +0530 Subject: [PATCH 09/20] Update server and client setup guide. (#1437) 1. Add Linux specific requirements. 2. Add debug info for common build errors. 3. Correct build step or any other statement wherever required. 4. For more info please see the attachment here: https://github.com/appsmithorg/appsmith/issues/1437 --- .../docker/templates/nginx-linux.conf.template | 12 ++++++------ contributions/ClientSetup.md | 10 ++++++---- contributions/ServerSetup.md | 10 ++++++---- 3 files changed, 18 insertions(+), 14 deletions(-) diff --git a/app/client/docker/templates/nginx-linux.conf.template b/app/client/docker/templates/nginx-linux.conf.template index b5e37d7935..44540cd407 100644 --- a/app/client/docker/templates/nginx-linux.conf.template +++ b/app/client/docker/templates/nginx-linux.conf.template @@ -45,19 +45,19 @@ server { location /api { proxy_set_header X-Forwarded-Proto $scheme; proxy_set_header X-Forwarded-Host $host; - proxy_pass http://localhost:8080; + proxy_pass https://release-api.appsmith.com; } location /oauth2 { proxy_set_header X-Forwarded-Proto $scheme; proxy_set_header X-Forwarded-Host $host; - proxy_pass http://localhost:8080; + proxy_pass https://release-api.appsmith.com; } location /login { proxy_set_header X-Forwarded-Proto $scheme; proxy_set_header X-Forwarded-Host $host; - proxy_pass http://localhost:8080; + proxy_pass https://release-api.appsmith.com; } } @@ -112,19 +112,19 @@ server { location /api { proxy_set_header X-Forwarded-Proto $scheme; proxy_set_header X-Forwarded-Host $host; - proxy_pass http://localhost:8080; + proxy_pass https://release-api.appsmith.com; } location /oauth2 { proxy_set_header X-Forwarded-Proto $scheme; proxy_set_header X-Forwarded-Host $host; - proxy_pass http://localhost:8080; + proxy_pass https://release-api.appsmith.com; } location /login { proxy_set_header X-Forwarded-Proto $scheme; proxy_set_header X-Forwarded-Host $host; - proxy_pass http://localhost:8080; + proxy_pass https://release-api.appsmith.com; } } diff --git a/contributions/ClientSetup.md b/contributions/ClientSetup.md index 058520cd7e..45df2d09d8 100644 --- a/contributions/ClientSetup.md +++ b/contributions/ClientSetup.md @@ -55,12 +55,13 @@ cp ../../.env.example ../../.env ### Steps to build & run the code: 1. Run `yarn` -2. Run `yarn start` + Note: -- On Ubuntu Linux platform, please run the following cmd before step 2 above: +- On Ubuntu Linux platform, please run the following cmd before step 2 below: ``` echo fs.inotify.max_user_watches=524288 | sudo tee -a /etc/sysctl.conf && sudo sysctl -p ``` +2. Run `yarn start` 🎉 Your Appsmith client is now running on https://dev.appsmith.com. @@ -75,7 +76,7 @@ node versions to be used in different projects. Check below for installation and 2. In the root of the project, run `nvm use 10.16.3` or `fnm use 10.16.3`. #### If you would like to hit a different Appsmith server: -- Change the API endpoint in the Nginx configuration files (`app/client/docker/templates/nginx-linux.conf.template` or `app/client/docker/templates/nginx-mac.conf.template`). By default it points to the cloud hosted server https://release-api.appsmith.com. If you want it to point to your local instance, then replace all such ip instances with https://localhost:8080 +- Change the API endpoint in the Nginx configuration files (`app/client/docker/templates/nginx-linux.conf.template` or `app/client/docker/templates/nginx-mac.conf.template`). By default it points to the cloud hosted server https://release-api.appsmith.com. If you want it to point to your local instance, then replace all such ip instances with `https://host.docker.internal:8080` for macOS or `http://localhost:8080` for Ubuntu. Please note that the communication with localhost uses http protocol instead of https. - Run `start-https.sh` script again. - Run ``` @@ -96,4 +97,5 @@ yarn start ## Need Assistance If you are unable to resolve any issue while doing the setup: - Please re-read all the steps and make sure you follow all instructions. -- In case step (1) does not resolve your issue, please send an email to support@appsmith.com . Team Appsmith will be happy to help you. +- In case step (1) does not resolve your issue, please send an email to support@appsmith.com. Team Appsmith will be happy to help you. +- In case you notice any discrepancy, please raise an issue on github and/or send an email to support@appsmith.com. diff --git a/contributions/ServerSetup.md b/contributions/ServerSetup.md index e873a3ac2e..2889e41b66 100644 --- a/contributions/ServerSetup.md +++ b/contributions/ServerSetup.md @@ -38,10 +38,11 @@ This command creates a `.env` file in the `app/server` folder. All run scripts p ./build.sh ``` Note: -- On Ubuntu Linux environment docker needs root privilege, hence ./build.sh script needs to be run with roon privilege as well. +- If you want to skip tests, you can pass -DskipTests flag to the build cmd. +- On Ubuntu Linux environment docker needs root privilege, hence ./build.sh script needs to be run with root privilege as well. - On Ubuntu Linux environment, the script may not be able to read .env file, so it is advised that you run the cmd like: ``` -sudo APPSMITH_MONGODB_URI="mongodb://localhost:27017/appsmith" APPSMITH_REDIS_URL="redis://127.0.0.1:6379" APPSMITH_MAIL_ENABLED=false APPSMITH_ENCRYPTION_PASSWORD=abcd APPSMITH_ENCRYPTION_SALT=abcd ./buid.sh +sudo APPSMITH_MONGODB_URI="mongodb://localhost:27017/appsmith" APPSMITH_REDIS_URL="redis://127.0.0.1:6379" APPSMITH_MAIL_ENABLED=false APPSMITH_ENCRYPTION_PASSWORD=abcd APPSMITH_ENCRYPTION_SALT=abcd ./build.sh ``` - If the volume containing docker's data root path (macOS: ~/Library/Containers/com.docker.docker/Data/vms/0/, Ubuntu: /var/lib/docker/) has less than 2 GB space free, then the script may fail with the following error: Check failed: Docker environment should have more than 2GB free disk space. There are two ways to resolve this issue (1) free up space (2) change docker's data root path. @@ -57,7 +58,7 @@ By default, the server will start on port 8080. 7. When the server starts, it automatically runs migrations on MongoDB and will populate it with some initial required data. -8. You can check the status of the server by hitting the endpoint: [http://localhost:8080](http://localhost:8080) on your browser. By default you should see a HTTP 401 error. +8. You can check the status of the server by hitting the endpoint: [http://localhost:8080](http://localhost:8080) on your browser. By default you should see an HTTP 401 error. ## Setting up a local MongoDB @@ -86,4 +87,5 @@ When using this command, the value of `APPSMITH_REDIS_URI` should be set to `red ## Need Assistance If you are unable to resolve any issue while doing the setup: - Please re-read all the steps and make sure you follow all instructions. -- In case step (1) does not resolve your issue, please send an email to support@appsmith.com . Team Appsmith will be happy to help you. +- In case step (1) does not resolve your issue, please send an email to support@appsmith.com. Team Appsmith will be happy to help you. +- In case you notice any discrepancy, please raise an issue on github and/or send an email to support@appsmith.com. From 330352dda52dc15cfb25b6ebc4e9509be3b78f5b Mon Sep 17 00:00:00 2001 From: Sumit Kumar Date: Thu, 29 Oct 2020 16:47:24 +0530 Subject: [PATCH 10/20] Update contributions/ClientSetup.md Co-authored-by: Arpit Mohan --- contributions/ClientSetup.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/contributions/ClientSetup.md b/contributions/ClientSetup.md index 8761ae9a11..28898f822a 100644 --- a/contributions/ClientSetup.md +++ b/contributions/ClientSetup.md @@ -97,5 +97,5 @@ yarn start ## Need Assistance If you are unable to resolve any issue while doing the setup: - Please re-read all the steps and make sure you follow all instructions. -- In case step (1) does not resolve your issue, please send an email to support@appsmith.com. Team Appsmith will be happy to help you. +- In case step (1) does not resolve your issue, please initiate a Github discussion or send an email to support@appsmith.com. We'll be happy to help you. - In case you notice any discrepancy, please raise an issue on github and/or send an email to support@appsmith.com. From af7e4b434339b9a8a0286f7225e258e0d923303d Mon Sep 17 00:00:00 2001 From: Sumit Kumar Date: Thu, 29 Oct 2020 16:47:33 +0530 Subject: [PATCH 11/20] Update contributions/ClientSetup.md Co-authored-by: Arpit Mohan --- contributions/ClientSetup.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/contributions/ClientSetup.md b/contributions/ClientSetup.md index 28898f822a..999d47d95c 100644 --- a/contributions/ClientSetup.md +++ b/contributions/ClientSetup.md @@ -98,4 +98,4 @@ yarn start If you are unable to resolve any issue while doing the setup: - Please re-read all the steps and make sure you follow all instructions. - In case step (1) does not resolve your issue, please initiate a Github discussion or send an email to support@appsmith.com. We'll be happy to help you. -- In case you notice any discrepancy, please raise an issue on github and/or send an email to support@appsmith.com. +- In case you notice any discrepancy, please raise an issue on Github and/or send an email to support@appsmith.com. From 548eb23a01fb3e1826de151347fac3fe7390ee11 Mon Sep 17 00:00:00 2001 From: Sumit Kumar Date: Thu, 29 Oct 2020 16:47:46 +0530 Subject: [PATCH 12/20] Update contributions/ServerSetup.md Co-authored-by: Arpit Mohan --- contributions/ServerSetup.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/contributions/ServerSetup.md b/contributions/ServerSetup.md index 2889e41b66..9244d7e7b2 100644 --- a/contributions/ServerSetup.md +++ b/contributions/ServerSetup.md @@ -38,7 +38,7 @@ This command creates a `.env` file in the `app/server` folder. All run scripts p ./build.sh ``` Note: -- If you want to skip tests, you can pass -DskipTests flag to the build cmd. +- If you want to skip tests, you can pass `-DskipTests` flag to the build cmd. - On Ubuntu Linux environment docker needs root privilege, hence ./build.sh script needs to be run with root privilege as well. - On Ubuntu Linux environment, the script may not be able to read .env file, so it is advised that you run the cmd like: ``` From 4312db64057de9593eb45e186cd89f5c3fcb4284 Mon Sep 17 00:00:00 2001 From: Sumit Kumar Date: Thu, 29 Oct 2020 19:03:02 +0530 Subject: [PATCH 13/20] Update ClientSetup.md --- contributions/ClientSetup.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/contributions/ClientSetup.md b/contributions/ClientSetup.md index 999d47d95c..1e34df32cf 100644 --- a/contributions/ClientSetup.md +++ b/contributions/ClientSetup.md @@ -67,7 +67,7 @@ echo fs.inotify.max_user_watches=524288 | sudo tee -a /etc/sysctl.conf && sudo s This URL must be opened with https and not have the port 3000 in it -By default your client app points to the local api server - `http://host.docker.internal:8080` for MacOS or `http://localhost:8080` for Linux. Your page will load with errors if you don't have the api server running on your local system. To setup the api server on your local system please follow the instructions here: `https://github.com/appsmithorg/appsmith/blob/release/contributions/ServerSetup.md` +By default your client app points to the local api server - `http://host.docker.internal:8080` for MacOS or `http://localhost:8080` for Linux. Your page will load with errors if you don't have the api server running on your local system. To setup the api server on your local system please follow the instructions here: https://github.com/appsmithorg/appsmith/blob/release/contributions/ServerSetup.md #### If yarn start throws mismatch node version error This error occurs because the node version is not compatible with the app environment. In this case Node version manager can be used which allows multiple From 2d320c1508702b3c868b90e73544ef8226ef67b0 Mon Sep 17 00:00:00 2001 From: Sumit Kumar Date: Thu, 29 Oct 2020 19:07:52 +0530 Subject: [PATCH 14/20] Update ClientSetup.md --- contributions/ClientSetup.md | 9 ++------- 1 file changed, 2 insertions(+), 7 deletions(-) diff --git a/contributions/ClientSetup.md b/contributions/ClientSetup.md index 1e34df32cf..8e2a2e7fff 100644 --- a/contributions/ClientSetup.md +++ b/contributions/ClientSetup.md @@ -33,17 +33,12 @@ Note: ``` cat /etc/hosts | grep appsmith ``` +3. Run cmd `cp .env.example .env` -3. Run the script `start-https.sh` in order to start the nginx container that will proxy the frontend code on your local system. +4. Run the script `start-https.sh` in order to start the nginx container that will proxy the frontend code on your local system. ```bash cd app/client ./start-https.sh -``` -Note: -- If you see the following error: `Please populate the .env at the root of the project and run again`, then run the following cmd and try again: -``` -cp ../../.env.example ../../.env -``` #### WSL (Windows Subsystem for Linux) From 1cb686baf9134a595c8aea26b52707b78d39cad2 Mon Sep 17 00:00:00 2001 From: Sumit Kumar Date: Thu, 29 Oct 2020 19:08:21 +0530 Subject: [PATCH 15/20] Update ClientSetup.md --- contributions/ClientSetup.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/contributions/ClientSetup.md b/contributions/ClientSetup.md index 8e2a2e7fff..dd3824078b 100644 --- a/contributions/ClientSetup.md +++ b/contributions/ClientSetup.md @@ -33,7 +33,7 @@ Note: ``` cat /etc/hosts | grep appsmith ``` -3. Run cmd `cp .env.example .env` +3. Run cmd: `cp .env.example .env` 4. Run the script `start-https.sh` in order to start the nginx container that will proxy the frontend code on your local system. ```bash From 2bc60d70cb882f161411afdf793054c19001f018 Mon Sep 17 00:00:00 2001 From: Sumit Kumar Date: Thu, 29 Oct 2020 19:09:23 +0530 Subject: [PATCH 16/20] Update ClientSetup.md --- contributions/ClientSetup.md | 1 + 1 file changed, 1 insertion(+) diff --git a/contributions/ClientSetup.md b/contributions/ClientSetup.md index dd3824078b..8a976561a7 100644 --- a/contributions/ClientSetup.md +++ b/contributions/ClientSetup.md @@ -39,6 +39,7 @@ cat /etc/hosts | grep appsmith ```bash cd app/client ./start-https.sh +``` #### WSL (Windows Subsystem for Linux) From 8b8a2c8cd677494723ca586bb6014b4fef14bd9a Mon Sep 17 00:00:00 2001 From: Sumit Kumar Date: Thu, 29 Oct 2020 19:18:53 +0530 Subject: [PATCH 17/20] Update ServerSetup.md --- contributions/ServerSetup.md | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/contributions/ServerSetup.md b/contributions/ServerSetup.md index 9244d7e7b2..5eeef0918d 100644 --- a/contributions/ServerSetup.md +++ b/contributions/ServerSetup.md @@ -37,6 +37,7 @@ This command creates a `.env` file in the `app/server` folder. All run scripts p ``` ./build.sh ``` +This command will create a `dist` folder which contains the final packaged jar along with multiple jars for the binaries for plugins as well. Note: - If you want to skip tests, you can pass `-DskipTests` flag to the build cmd. - On Ubuntu Linux environment docker needs root privilege, hence ./build.sh script needs to be run with root privilege as well. @@ -44,9 +45,12 @@ Note: ``` sudo APPSMITH_MONGODB_URI="mongodb://localhost:27017/appsmith" APPSMITH_REDIS_URL="redis://127.0.0.1:6379" APPSMITH_MAIL_ENABLED=false APPSMITH_ENCRYPTION_PASSWORD=abcd APPSMITH_ENCRYPTION_SALT=abcd ./build.sh ``` -- If the volume containing docker's data root path (macOS: ~/Library/Containers/com.docker.docker/Data/vms/0/, Ubuntu: /var/lib/docker/) has less than 2 GB space free, then the script may fail with the following error: Check failed: Docker environment should have more than 2GB free disk space. There are two ways to resolve this issue (1) free up space (2) change docker's data root path. +- If the volume containing docker's data root path (macOS: `~/Library/Containers/com.docker.docker/Data/vms/0/`, Ubuntu: `/var/lib/docker/`) has less than 2 GB of free space, then the script may fail with the following error: +``` +Check failed: Docker environment should have more than 2GB free disk space. +``` +There are two ways to resolve this issue: (1) free up more space (2) change docker's data root path. -This command will create a `dist` folder which contains the final packaged jar along with multiple jars for the binaries for plugins as well. 6. Start the Java server by running From d2661590e44b98573d656ade62d75438968d19bc Mon Sep 17 00:00:00 2001 From: Sumit Kumar Date: Thu, 29 Oct 2020 19:20:32 +0530 Subject: [PATCH 18/20] Update ClientSetup.md --- contributions/ClientSetup.md | 1 - 1 file changed, 1 deletion(-) diff --git a/contributions/ClientSetup.md b/contributions/ClientSetup.md index 8a976561a7..06d7ca3e43 100644 --- a/contributions/ClientSetup.md +++ b/contributions/ClientSetup.md @@ -92,6 +92,5 @@ yarn start ## Need Assistance If you are unable to resolve any issue while doing the setup: -- Please re-read all the steps and make sure you follow all instructions. - In case step (1) does not resolve your issue, please initiate a Github discussion or send an email to support@appsmith.com. We'll be happy to help you. - In case you notice any discrepancy, please raise an issue on Github and/or send an email to support@appsmith.com. From 7f6b7e4d834a69cb02cd26fb5a24178400ad7f0c Mon Sep 17 00:00:00 2001 From: Sumit Kumar Date: Thu, 29 Oct 2020 19:21:48 +0530 Subject: [PATCH 19/20] Update ClientSetup.md --- contributions/ClientSetup.md | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/contributions/ClientSetup.md b/contributions/ClientSetup.md index 06d7ca3e43..52c236ecb6 100644 --- a/contributions/ClientSetup.md +++ b/contributions/ClientSetup.md @@ -91,6 +91,5 @@ yarn start ## Need Assistance -If you are unable to resolve any issue while doing the setup: -- In case step (1) does not resolve your issue, please initiate a Github discussion or send an email to support@appsmith.com. We'll be happy to help you. +- If you are unable to resolve any issue while doing the setup, please initiate a Github discussion or send an email to support@appsmith.com. We'll be happy to help you. - In case you notice any discrepancy, please raise an issue on Github and/or send an email to support@appsmith.com. From 17f336b7c69832ce5dc6c3cf1bb67e6225bf2aff Mon Sep 17 00:00:00 2001 From: Sumit Kumar Date: Thu, 29 Oct 2020 19:21:59 +0530 Subject: [PATCH 20/20] Update ServerSetup.md --- contributions/ServerSetup.md | 6 ++---- 1 file changed, 2 insertions(+), 4 deletions(-) diff --git a/contributions/ServerSetup.md b/contributions/ServerSetup.md index 5eeef0918d..98e0dd173a 100644 --- a/contributions/ServerSetup.md +++ b/contributions/ServerSetup.md @@ -89,7 +89,5 @@ docker run -p 127.0.0.1:6379:6379 --name appsmith-redis redis When using this command, the value of `APPSMITH_REDIS_URI` should be set to `redis://localhost:6379`. ## Need Assistance -If you are unable to resolve any issue while doing the setup: -- Please re-read all the steps and make sure you follow all instructions. -- In case step (1) does not resolve your issue, please send an email to support@appsmith.com. Team Appsmith will be happy to help you. -- In case you notice any discrepancy, please raise an issue on github and/or send an email to support@appsmith.com. +- If you are unable to resolve any issue while doing the setup, please initiate a Github discussion or send an email to support@appsmith.com. We'll be happy to help you. +- In case you notice any discrepancy, please raise an issue on Github and/or send an email to support@appsmith.com.