Protei/PromucFlow_constructor
2
0
Fork 0
Code Issues Pull Requests Actions 2 Packages Projects Releases Wiki Activity

Update server and client setup guide. (#1437)

Browse Source 
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
This commit is contained in:
Sumit Kumar 2020-10-28 12:47:18 +05:30
parent c993cfebe7
commit c78906e648
1 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
contributions/ServerSetup.md
View File

@ -37,7 +37,8 @@ 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
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.
@ -51,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
@ -75,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`.