Documentation

Build and deploy

Introduction

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).

Prerequisites

Install prerequisites on Ubuntu:

Add Node.js and Yarn latest version repo:

  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_lts.x | sudo -E bash -

Install packages:

sudo apt update
sudo apt install openjdk-11-jdk
sudo apt install maven
sudo apt install yarn
sudo apt install nodejs
sudo apt install npm
sudo npm install -g lerna

Install prerequisites on Windows:

  • Download and install AdoptOpenJDK
  • Download and extract Maven .
  • Add path to Maven bin folder in system PATH
  • Download and install Node.js. NPM comes along with Node.js, NPX/Lerna will be installed in the build script.
  • Download and install Yarn

If lerna is not installed along with Node.js you can do it manually:

npm install -g lerna

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-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.

Note: 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.