chore: fix server setup documentation (#23279)
Fixes #23257 This PR fixes the structure of content in server setup documentation.
This commit is contained in:
Rajat Agrawal
GitHub
parent
1a4961d089
commit
65fa493843
|
|
@ -1,29 +1,37 @@
|
|||
# Running Server Codebase
|
||||
|
||||
This document explains how you can setup a development environment for Appsmith server. 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.
|
||||
|
||||
|
||||
[](https://www.youtube.com/watch?v=W2qbuUYGrQs)
|
||||
|
||||
<br />
|
||||
This document explains how you can setup a development environment for Appsmith server.
|
||||
|
||||
# Setup with Docker
|
||||
There are two ways to run Appsmith server.
|
||||
|
||||
You can run the server codebase in a docker container. This is the easiest way to get the server up and running if you are more interested in contributing to the client codebase.
|
||||
* [Using a Docker Image](#setup-with-docker)
|
||||
* [Running the code locally](#local-setup)
|
||||
|
||||
## What's in the box
|
||||
## Setup with Docker
|
||||
|
||||
* You can run the server codebase in a docker container.
|
||||
|
||||
* This method is recommended if you just want to run the backend server for testing/contributing to frontend code. If you would like to make edits to the source code of server, use [local server method](#local-setup)
|
||||
|
||||
- ## What's in the docker container
|
||||
* Appsmith server
|
||||
* MongoDB database
|
||||
* Redis instance
|
||||
|
||||
## Pre-requisites
|
||||
* ## Pre-requisites
|
||||
|
||||
* [Docker](https://docs.docker.com/get-docker/)
|
||||
|
||||
## Steps for setup
|
||||
* ## Setup
|
||||
|
||||
1. Clone the Appsmith repository and `cd` into it
|
||||
```console
|
||||
|
||||
```
|
||||
git clone https://github.com/appsmithorg/appsmith.git
|
||||
cd appsmith
|
||||
```
|
||||
|
|
@ -41,11 +49,13 @@ docker-compose up -d
|
|||
```
|
||||
5. Have fun!
|
||||
|
||||
|
||||
# Local Setup
|
||||
|
||||
## Pre-requisites
|
||||
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.
|
||||
|
|
@ -56,19 +66,22 @@ Before you can start to hack on the Appsmith server, your machine should have th
|
|||
|
||||
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:
|
||||
|
||||
The following command will start a MongoDB docker instance locally:
|
||||
|
||||
```console
|
||||
```
|
||||
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.
|
||||
* 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](https://hub.docker.com/_/mongo).
|
||||
* 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](https://hub.docker.com/_/mongo).
|
||||
|
||||
MongoDB will now be running on `mongodb://localhost:27017/appsmith`.
|
||||
* MongoDB will now be running on `mongodb://localhost:27017/appsmith`.
|
||||
|
||||
### Enabling replica set for mongo
|
||||
* <b>Mongo running inside docker</b>
|
||||
|
||||
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
|
||||
|
|
@ -79,30 +92,35 @@ mongosh
|
|||
```
|
||||
rs.initiate({"_id": "rs0", "members" : [{"_id":0 , "host": "localhost:27017" }]})
|
||||
```
|
||||
|
||||
### Convert a standalone MongoDB node to a replica set for non docker based set up
|
||||
* <b>Standalone Mongo running on the system</b> (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()”
|
||||
|
||||
```
|
||||
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()
|
||||
```
|
||||
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:
|
||||
- The following command will start a Redis docker instance locally:
|
||||
|
||||
```console
|
||||
```
|
||||
docker run -d -p 127.0.0.1:6379:6379 --name appsmith-redis redis
|
||||
```
|
||||
|
||||
Redis will now be running on `redis://localhost:6379`.
|
||||
- Redis will now be running on `redis://localhost:6379`.
|
||||
|
||||
<br />
|
||||
With the prerequisites met, let's build the code.
|
||||
|
||||
## Building and running the code
|
||||
### Building and running the code
|
||||
|
||||
1. Clone Appsmith repository.
|
||||
2. Change your directory to `app/server`.
|
||||
|
|
@ -114,9 +132,8 @@ 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.
|
||||
|
||||
#### 4. Setup Environment file
|
||||
|
||||
Create a copy of the `envs/dev.env.example`
|
||||
4. Setup Environment file
|
||||
- Create a copy of the `envs/dev.env.example`
|
||||
|
||||
```console
|
||||
cp envs/dev.env.example .env
|
||||
|
|
@ -136,34 +153,37 @@ APPSMITH_MONGODB_URI="mongodb://localhost:27017/appsmith?replicaSet=<replica-set
|
|||
```console
|
||||
./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:
|
||||
- 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.
|
||||
- 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:
|
||||
```console
|
||||
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 of free space, then the script may fail with the following error:
|
||||
### 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.
|
||||
|
||||
```console
|
||||
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.
|
||||
- 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:
|
||||
```console
|
||||
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
|
||||
```
|
||||
|
||||
|
||||
7. Start the Java server by running
|
||||
|
||||
8. Start the Java server by running
|
||||
```console
|
||||
./scripts/start-dev-server.sh
|
||||
```
|
||||
|
||||
By default, the server will start on port 8080.
|
||||
- By default, the server will start on port 8080.
|
||||
|
||||
8. When the server starts, it automatically runs migrations on MongoDB and will populate it with some initial required data.
|
||||
|
||||
9. 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.
|
||||
- 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](http://localhost:8080/api/v1/users/me) on your browser.
|
||||
|
||||
## Local setup on Windows using WSL2
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue
Block a user