From fbcd10b65bd74f2cab130f839c3bd3cc613e6348 Mon Sep 17 00:00:00 2001 From: Sumit Kumar Date: Wed, 28 Oct 2020 18:00:05 +0530 Subject: [PATCH] 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 | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/contributions/ServerSetup.md b/contributions/ServerSetup.md index c60102df96..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.