Quickstart of the Server

June 8, 2026 · View on GitHub

Table of Contents

Configuration
Running locally

Configuration

Refer to the Configuration for configuration options.

Running locally

Server subproject qualifier: :app
Assuming your working directory is the repo root

NOTE: one may use the -p flag for ./gradlew in order to avoid specifying the target subproject repeatedly on each task when running multiple tasks. When running only a single task, however, it is recommended to use the project qualifier (i.e. :app:) for both simplicity and clarity.

Build the Server

NOTE: if you have not done so already, it is generally recommended to build the entire repo first:
./gradlew clean build -x test

To quickly build the Server sources (without running tests), do the following:
```
./gradlew clean build -x test
```
Before building the server ensure your tests run successfully:
```
./gradlew clean qualityGate build runSuites
```
To build the Server docker image, do the following:
```
./gradlew :app:createDockerImage
```

Run the Server

To start the Server, do the following:
```
./gradlew :app:startDockerContainer
```

Run the Server with Debug

To start the Server with debug enabled, do the following:
```
./gradlew :app:startDockerDebugContainer
```
Attach your remote jvm debugger to port 5005.

Stop the Server

To stop the Server do the following:
```
./gradlew :app:stopDockerContainer
```