Table of contents

• Prerequisites
  • Install prerequisites on Ubuntu
  • Install prerequisites on Windows
• Build and deploy
• Running server
• Running Frontend in Dev mode
  • Prerequisites
  • Installation Steps
  • Developing in VSCode

CloudBeaver is a web server which provides a rich web interface.
It consists of two parts:

• Server back-end. It is written in Java and reuses "platform" libraries of DBeaver.
• Front-end part. It is written in TypeScript and JavaScript.

This build process is relatively complicated (and also consists of two parts).

Tip: For a practical demonstration of CloudBeaver Enterprise Edition's capabilities, please refer to our demo server. For more information, see Demo Server.

Prerequisites

• Java 21.
• Apache Maven (3.9.9+).
• Node.js (LTS 22.15.0).
• Yarn (4.x).
• NPM.

Important: CloudBeaver includes OpenJDK, which is an open-source version of Java. This means you do not need to purchase a separate Java license to use CloudBeaver.

Install prerequisites on Ubuntu

Add Node.js and Yarn repositories:

curl -sL https://dl.yarnpkg.com/debian/pubkey.gpg | sudo apt-key add -
echo "deb https://dl.yarnpkg.com/debian/ stable main" | sudo tee /etc/apt/sources.list.d/yarn.list
curl -sL https://deb.nodesource.com/setup_22.x | sudo -E bash -

Install packages:

sudo apt update
sudo apt install openjdk-21-jdk maven yarn nodejs npm

Install prerequisites on Windows

• Install Java 21.
• Download and extract Maven, then add its bin folder to the system PATH.
• Install Node.js LTS 22.15.0 (includes NPM).
• Install Yarn 4.x.

Tip: You can check your installed versions with java -version, mvn -v, node -v, npm -v, and yarn -v.

Build and deploy

git clone https://github.com/dbeaver/cloudbeaver.git
cd cloudbeaver/deploy
./build.sh

The final artifacts can be found in deploy/cloudbeaver.

Running server

cd cloudbeaver
./run-cloudbeaver-server.sh

By default, the server listens to port 8978 (you can change it in conf/cloudbeaver.conf). So just navigate to http://localhost:8978. You can configure Nginx, Apache or any other web server in front of it.

You must be in the server root directory to run it. If you need to run it from some other directory, then you can set the environment variable CLOUDBEAVER_HOME to the server root directory.

Running Frontend in Dev mode

Prerequisites

• Ensure you have the correct Node.js version
  We recommend using the latest LTS (Long-Term Support) version. Check the official Node.js website: https://nodejs.org/
  The minimum supported version is v20.19.1.

• Ensure you have Yarn installed
  If not, see the instructions on the official website: https://yarnpkg.com/getting-started/install

• Enable Corepack
  To ensure that Corepack is enabled, run the following command:

  corepack enable
  

More about Corepack: https://yarnpkg.com/corepack

Installation Steps

1. Build the Backend Server.

   Navigate to the deploy directory and execute the build script. This script will handle cloning necessary repositories and building the backend. It also installs all frontend dependencies and builds it as well.

   • For macOS/Linux:

     cd deploy
     ./build.sh
     

   • For Windows:

     cd deploy
     ./build.bat
     

2. Navigate to the Directory with Build Artifacts

   • Change your current directory to the cloudbeaver folder within the deploy directory:

     cd cloudbeaver
     

3. Run the Backend Server.

   Start the backend server by running the execution script.

   • For macOS/Linux:

     ./run-cloudbeaver-server.sh
     

   • For Windows:

     ./run-server.bat
     

4. Navigate to the Webapp Directory.

   • Open a new terminal window or tab, and change your directory to the web application's product folder:

     cd webapp/packages/product-default
     

5. Run the Web Application.

   Start the web application development server, specifying the backend server's URL. The default URL is http://localhost:8978/.

   • For macOS/Linux:

     server=http://localhost:8978/ yarn dev
     

   • For Windows Command Prompt:

     set server=http://localhost:8978/ && yarn dev
     

   • For Windows PowerShell:

     $env:server="http://localhost:8978/"; yarn dev
     

     You should see a message with URL of your running dev server like below ➜ Local: http://localhost:8080/

Developing in VSCode

VSCode offers dedicated tasks to streamline development with our project, making it the recommended environment for working on the CloudBeaver Frontend.

To access these tasks, press F1 (or Cmd/Ctrl + Shift + P) in VSCode, select "Tasks: Run Task" from the command palette, and then choose the desired task from the list.

To start the local development server, follow these steps:

1. Execute the Build CE task. This task builds both the backend and frontend.
2. Run the Run Backend CE task to start the backend server.
3. Run the Run DevServer CE task.

These steps will launch the frontend in development mode and proxy API requests to your locally running backend, accessible at http://localhost:8080/.