Running Server Codebase

This document explains how you can setup a development environment for Appsmith server.

There are two ways to run Appsmith server.

Using a Docker Image
Running the code locally

Setup with Docker

Running the Appsmith Docker image as a container will grant you a running Appsmith server, along with its dependencies, like MongoDB and Redis. This is the easiest way to get started with Appsmith server.

Clone the Appsmith repository and change into it

git clone https://github.com/appsmithorg/appsmith.git
cd appsmith

Change your directory to deploy/docker
```
cd deploy/docker
```
Start
```
docker-compose up -d
```

Local Setup

As the server codebase is written in Java and is powered by Spring + WebFlux we need Java and Maven installed to build the code. In addition we also need one instance of MongoDB and Redis each to run Appsmith server. Lastly, we will set up IntelliJ IDEA to let you edit the code. Let's get those prerequisites installed on your machine.

MacOS/Unix Systems

Pre-requisites

Before you can start to hack on the Appsmith server, your machine should have the following installed:

Java - OpenJDK 17.
Maven - Version 3+ (preferably 3.6).
A MongoDB database - Refer to the Setting up a local MongoDB instance section to setup a MongoDB instance using Docker.
A Redis instance - Refer to the Setting up a local Redis instance section to setup a Redis instance using Docker.
An IDE - We use IntelliJ IDEA as our primary IDE for backend development. To set it up, refer to the Setting up IntelliJ IDEA section.

This document doesn't provide instructions to install Java and Maven because these vary between different operating systems and distributions. Please refer to the documentation of your operating system or package manager to install these. Next we will setup MongoDB and Redis using Docker.

Setting up a local MongoDB instance

The following command will start a MongoDB docker instance locally:

docker run -d -p 127.0.0.1:27017:27017 --name appsmith-mongodb --hostname=localhost -e MONGO_INITDB_DATABASE=appsmith -v /path/to/store/data:/data/db mongo --replSet rs0

Please change the /path/to/store/data to a valid path on your system. This is where MongoDB will persist it's data across runs of this container.
Note that this command doesn't set any username or password on the database so we make it accessible only from localhost using the 127.0.0.1: part in the port mapping argument. Please refer to the documentation of this image to learn how to set a username and password.
MongoDB will now be running on mongodb://localhost:27017/appsmith.

Enabling replica set for mongo
- Mongo running inside docker
  
  Please follow the below steps for enabling the replica set with mongo running inside the docker
  1. Connect to the mongo db running with a mongo shell. Use the below command
```
mongosh
```
  2. Once you are inside the mongo shell run the below command.
```
rs.initiate({"_id": "rs0", "members" : [{"_id":0 , "host": "localhost:27017" }]})
```
- Standalone Mongo running on the system (non-docker based mongo setup)
  - Upgrade the MongoDB version to 5.0 or higher
  - Close the mongoDB instance running in your local
  - Start the mongoDB in replica set mode and initiate the replica set
```
mongod --port 27017 --dbpath <path/to/db> --replSet <replica-set-name> && mongo --eval “rs.initiate()”
```
  - One can use following commands to check replica set status:
```
mongo appsmith
rs.status()
```
  - By this time you should have the mongo running with replica set

Setting up a local Redis instance

The following command will start a Redis docker instance locally:

docker run -d -p 127.0.0.1:6379:6379 --name appsmith-redis redis

Redis will now be running on redis://localhost:6379.

With the prerequisites met, let's build the code.

Building and running the code

Clone Appsmith repository.
Change your directory to app/server.
Run the following command:
```
mvn clean compile
```
This generates a bunch of classes required by IntelliJ for compiling the rest of the source code. Without this step, your IDE may complain about missing classes and will be unable to compile the code.
Setup Environment file
- Create a copy of the envs/dev.env.example
```
cp envs/dev.env.example .env
```
  This command creates a .env file in the app/server folder. All run scripts pick up environment configuration from this file.
Ensure that the environment variables APPSMITH_DB_URL and APPSMITH_REDIS_URI in the file .env point to your local running instances of MongoDB and Redis.
Update the replica set name with correct value in the mongo connection string in the .env file. The replica name is the same as passed here
```
APPSMITH_DB_URL="mongodb://localhost:27017/appsmith?replicaSet=<replica-set-name>"
```
Run the following command to create the final JAR for the Appsmith server:
```
./build.sh -Dmaven.test.skip
```
- This command will create a dist folder which contains the final packaged jar along with multiple jars for plugins as well.
- If you want to run the tests, you can remove -DskipTests flag from the build cmd.
Debugging
- 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:
  - Free up more space
  - Change docker's data root path.
- Linux/Ubuntu Environments
  - 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_DB_URL="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
```
Start the Java server by running
```
./scripts/start-dev-server.sh
```
- By default, the server will start on port 8080.
  - When the server starts, it automatically runs migrations on MongoDB and will populate it with some initial required data.
  - You can check the status of the server by hitting the endpoint: http://localhost:8080/api/v1/users/me on your browser.

Local setup on Windows using WSL2

Pre-requisites

Before you can start to hack on the Appsmith server, your machine should have the following installed:

WSL2 with Linux distro (preferably Ubuntu LTS). Refer to WSL2 installation on Windows.
Docker Desktop for Windows (must be with WSL backed/based engine). Refer to Install Docker Desktop on Windows.
An IDE - We use IntelliJ IDEA as our primary IDE for backend development.
Java - OpenJDK 17 in WSL.
Maven - Version 3+ (preferably 3.6) in WSL.

This document doesn't provide instructions to install Java and Maven because these vary between different operating systems and distributions. Please refer to the documentation of your operating system or package manager to install these.

Next we will setup MongoDB and Redis using Docker.

Note that as you have installed Docker Desktop with WSL based engine, you can execute all docker related setup using Windows terminal (CMD). All the docker containers will automatically be available on WSL.

Setting up a local MongoDB instance

The following command will start a MongoDB docker instance locally:

docker run -d -p 127.0.0.1:27017:27017 --name appsmith-mongodb --hostname=localhost -e MONGO_INITDB_DATABASE=appsmith -v /path/to/store/data:/data/db mongo mongod --replSet rs0

For Apple Silicon

For M1 chip change the base image to arm64v8 variant

docker run -d -p 127.0.0.1:27017:27017 --name appsmith-mongodb --hostname=localhost -e MONGO_INITDB_DATABASE=appsmith -v /path/to/store/data:/data/db arm64v8/mongo mongod --replSet rs0

Please change the /path/to/store/data to a valid path on your C drive (C:/) of your system (e.g. C:\mongodata). This is where MongoDB will persist it's data across runs of this container.

Note that this command doesn't set any username or password on the database so we make it accessible only from localhost using the 127.0.0.1: part in the port mapping argument. Please refer to the documentation of this image to learn how to set a username and password.

MongoDB will now be running on mongodb://localhost:27017/appsmith.

Setting up a local Redis instance

The following command will start a Redis docker instance locally:

docker run -d -p 127.0.0.1:6379:6379 --name appsmith-redis redis

For Apple Silicon

For M1 chip change the base image to arm64v8 variant

docker run -d -p 127.0.0.1:6379:6379 --name appsmith-redis arm64v8/redis

Redis will now be running on redis://localhost:6379.

With the initial configuration met, let's build the code.

Note that you have to execute further steps into WSL terminal not in CMD.

Setting up local file path for the git

To point to a custom Git Root where the git repositories will be persisted, update the env variable called APPSMITH_GIT_ROOT to point to your custom file path.

APPSMITH_GIT_ROOT=./path/to/repo/directory

Building and running the code

Clone Appsmith repository.
Change your directory to app/server.
Run the following command:

mvn clean compile

This generates a bunch of classes required by IntelliJ for compiling the rest of the source code. Without this step, your IDE may complain about missing classes and will be unable to compile the code.

Create a copy of the envs/dev.env.example

cp envs/dev.env.example .env

This command creates a .env file in the app/server folder. All run scripts pick up environment configuration from this file.

Ensure that the environment variables APPSMITH_DB_URL and APPSMITH_REDIS_URI in the file .env point to your local running instances of MongoDB and Redis.
Run the following command to create the final JAR for the Appsmith server:

./build.sh -DskipTests

This command will create a dist folder which contains the final packaged jar along with multiple jars for plugins as well.

Note:

If you want to run the tests, you can remove -DskipTests flag from 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_DB_URL="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 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.

Start the Java server by running

./scripts/start-dev-server.sh

By default, the server will start on port 8080.

When the server starts, it automatically runs migrations on MongoDB and will populate it with some initial required data.
You can check the status of the server by hitting the endpoint: http://localhost:8080 on your browser. By default you should see an HTTP 401 error.

Now the last bit, let's get your Intellij IDEA up and running.

Setting up IntelliJ IDEA

To run the project from within the IDE, you will need to make use of the run configuration that is part of the repository. The run configuration uses the EnvFile plugin to include environment variables in the path. Any and all tests can be run within the IDE by cloning this run configuration.

Install the plugin EnvFile from https://plugins.jetbrains.com/plugin/7861-envfile. This is required to load the environment configurations when the server starts.
Configure the Run/Debug configuration as shown in the screenshot below:

For being able to run or debug plugins, two are especially important:

VM Options: -Dpf4j.mode=development -Dpf4j.pluginsDir=appsmith-plugins .
Working Directory: The folder that contains appsmith-server, appsmith-plugins etc.

Please note when setting Working directory option. If the path is not correct, plugins will fail to load and cannot fetch data from mongo, redis

Load your env file by going to the EnvFile Tab in the Run/Debug configuration settings for your server.

Configuration settings for version 2021.1.2 (Community Edition) IntelliJ IDEA

After configuring settings as mentioned above, please also add the following to your IntelliJ IDEA setup.

[Optional] As shown in the image below, please enable the Store as Project checkbox to run the application from the main class specified.
Please enable the Always update snapshots checkbox so that the most recent build is picked up.

Happy hacking ✌️

Note:

In case the server doesn't work with the above config, please try re-compiling the code using the steps

mvn -B clean compile && ./build.sh -DskipTests

Running Tests on Server

Ensure that you have Redis running on your local system.
Run the command to execute tests

  cd app/server
  mvn clean package

Need Assistance

If you are unable to resolve any issue while doing the setup, please feel free to ask questions on our Discord channel or 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.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

ServerSetup.md

ServerSetup.md

Running Server Codebase

Setup with Docker

Local Setup

MacOS/Unix Systems

Pre-requisites

Setting up a local MongoDB instance

Enabling replica set for mongo

Setting up a local Redis instance

Building and running the code

Debugging

Linux/Ubuntu Environments

Local setup on Windows using WSL2

Pre-requisites

Setting up a local MongoDB instance

For Apple Silicon

Setting up a local Redis instance

For Apple Silicon

Setting up local file path for the git

Building and running the code

Setting up IntelliJ IDEA

Configuration settings for version 2021.1.2 (Community Edition) IntelliJ IDEA

Note:

Running Tests on Server

Need Assistance

Files

ServerSetup.md

Latest commit

History

ServerSetup.md

File metadata and controls

Running Server Codebase

Setup with Docker

Local Setup

MacOS/Unix Systems

Pre-requisites

Setting up a local MongoDB instance

Enabling replica set for mongo

Setting up a local Redis instance

Building and running the code

Debugging

Linux/Ubuntu Environments

Local setup on Windows using WSL2

Pre-requisites

Setting up a local MongoDB instance

For Apple Silicon

Setting up a local Redis instance

For Apple Silicon

Setting up local file path for the git

Building and running the code

Setting up IntelliJ IDEA

Configuration settings for version 2021.1.2 (Community Edition) IntelliJ IDEA

Note:

Running Tests on Server

Need Assistance