This article explains how to set up and manage pre-configured database connections for the CloudBeaver server. These connections are defined by the administrator and stored on the server, making them unmodifiable by end users. Users can choose from these pre-configured connections directly through the main CloudBeaver toolbar and only need to provide their username and password to access the datasource; no other parameters are necessary.

For information about server and workspace configuration, see Server configuration.

All project-level configurations are located in the

This file contains the settings for each pre-configured connection, allowing the CloudBeaver server to manage and display these connections.

Example configuration:

{

  "folders": {

  },

  "connections": {

    "dbeaver-sample-database-sqlite-1": {

      "provider": "sqlite",

      "driver": "sqlite_jdbc",

      "name": "DBeaver Sample Database (SQLite)",

      "save-password": true,

      "show-system-objects": true,

      "configuration": {

        "database": "/Users/user/Library/DBeaverData/workspace6/.metadata/sample-database-sqlite-1/Chinook.db",

        "url": "jdbc:sqlite:/Users/user/Library/DBeaverData/workspace6/.metadata/sample-database-sqlite-1/Chinook.db",

        "configurationType": "MANUAL",

        "type": "dev",

        "closeIdleConnection": true

      }

    }

  }

}

Tip: This file follows the same format as the DBeaver datasources configuration file. You can create this configuration in DBeaver and then copy it to your CloudBeaver server.

CloudBeaver can be deployed on AWS using a preconfigured Amazon Machine Image (AMI).

Before you start, ensure you have an AWS account. If you don’t have one, you can create it on the AWS signup page.

1. Log in to your AWS account and go to the EC2 Dashboard.
2. From the left-hand menu, select AMI Catalog under Images.
3. In the AMI catalog, click on Community AMIs.
4. In the Search bar, type
   cloudbeaver-ee
   and hit Enter.

5. You’ll see a list of available AMIs. Select the version of CloudBeaver you’d like to deploy.

   Tip: Choose the most up-to-date version to get the latest features.

1. After selecting the AMI, click Launch Instance with AMI.
2. Choose an Instance Type that meets the minimum requirements:
   • 2 CPUs
   • 4 GB RAM
   • 100 GB SSD storage (recommended)

1. During instance configuration, set up your security group:
   • For security reasons, it’s recommended not to make the instance publicly accessible.
   • Limit inbound traffic to specific IPs (e.g., your office IP address) and only open the necessary ports:
     • Allow SSH traffic: For administration and secure remote access.
     • Allow HTTPS traffic from the internet: To securely serve content over the web.
     • Allow HTTP traffic from the internet: For basic web traffic access.

Tip: Learn more about AWS security group best practices in the AWS Security Groups documentation.

1. After configuring all the settings, review your instance details.
2. Click Launch and select or create a new key pair to access the instance later via SSH.
3. Once the instance launches, monitor its status in the EC2 dashboard.
4. Begin the initial setup of the CloudBeaver.

Tip: For detailed steps on the initial setup and server management, see the Managing cloud deployed services guide.

This guide shows how to deploy CloudBeaver Enterprise on Google Cloud Platform (GCP) using both the Google Cloud Console and the Google Cloud CLI.

Before you begin, make sure you have:

• A Google Cloud account for accessing GCP services.
• Compute Engine set up in your project.

If you don’t have a GCP account, sign up on the Google Cloud signup page.

To deploy CloudBeaver in Google Cloud, you need certain permissions to create and manage resources like virtual machines, disks, and networks. Ensure you have the necessary permissions for your project.

Tip: For a full list of permissions and more information on how to manage them, see the official Google Cloud Permissions documentation.If you don’t have the required permissions, contact your system administrator.

1. Log in to the Google Cloud Console, then go to Compute Engine -> Images. Click [+] Create image.

2. Complete the Create an image form:

   • Enter the image name in the format
     cloudbeaver-ee-server-ubuntu-%version%
     or
     cloudbeaver-ee-server-rhel-%version%
     , depending on the operating system.
   • Select Virtual disk (VMDK, VHD), and in the Virtual disk file field, enter this URI:
     cloudbeaver-ee-server/
     . Click BROWSE and choose your version.

Tip: Replace

%version%

with the desired version number, such as

24-2-0

.

3. Click Create. The process may take up to 15 minutes.

1. After the image is imported, navigate to the Images tab, find your imported image, and click [+] Create instance.

2. Name your instance and set up the following:

   • Under Machine configuration, choose a machine type with at least 1 CPU and 4GB RAM for optimal CloudBeaver performance.
   • Click Change, select your custom image, and set the disk size to at least 100GB.

3. In the Firewall section, check Allow HTTP traffic and Allow HTTPS traffic to make the instance accessible online.

4. Click Create. Your instance will be ready in a few minutes. Verify by pasting its External IP into your browser.

5. Begin the initial configuration of the CloudBeaver server in your browser.

Tip: For more detailed steps on configuring and managing the server, see the Managing cloud deployed services guide.

1. In the Google Cloud Console, go to Compute Engine and click Activate Cloud Shell to launch the CLI within GCP.

2. Authorize any prompts if needed.

Run this

gcloud beta compute instances create cloudbeaver-ee-server \  

--zone=us-central1-a \  

--machine-type=e2-medium \  

--tags=http-server,https-server \  

--image=https://www.googleapis.com/compute/v1/projects/dbeaver-public/global/images/cloudbeaver-ee-ubuntu-24-2-0 \  

--create-disk=auto-delete=yes \  

--boot-disk-size=100GB --boot-disk-device-name=cloudbeaver-ee-server

You can customize the command as needed. For more details on using the Google Cloud CLI, see the official documentation.

Tip: Replace the

--image

URL with a different version if needed.

1. After the instance is created, retrieve its external IP (needed for accessing the CloudBeaver server):

gcloud compute instances list --filter="name:cloudbeaver-ee-server" --format="get(networkInterfaces[0].accessConfigs[0].natIP)"

This command will return the

2. Use the

   external-ip
   to start configuring and accessing the CloudBeaver interface.

3. In your browser, go to

   http://<external-ip>/
   , where
   <external-ip>
   is the public IP address of your GCP instance.

4. You’ll be redirected to CloudBeaver’s initial configuration wizard to complete the setup.

Tip: For guidance on locating your instance’s public IP address, see GCP: Viewing IP Addresses.

• https://www.googleapis.com/compute/v1/projects/dbeaver-public/global/images/cloudbeaver-ee-ubuntu-%version%
• https://www.googleapis.com/compute/v1/projects/dbeaver-public/global/images/cloudbeaver-ee-rhel-%version%

Tip: Replace

%version%

with the desired version number, such as

24-2-0

. For more information on tags, see CloudBeaver release cycles.

This guide explains how to deploy CloudBeaver Enterprise on Microsoft Azure using the Azure Portal.

Before you begin, ensure you have a Microsoft Azure account for accessing Azure services.

Tip: If you don’t have an Azure account, sign up on the Azure signup page.

1. Log in to the Azure Portal and search for Community images in the search bar.
2. In the search bar on the left side under Community images, enter
   cloudbeaver-ee
   . Select the image for your region from the list and click Create VM.

1. Project details:

   • Subscription: Choose your Azure subscription.
   • Resource group: Create a new group or select an existing one.

2. Instance details:

   • Virtual machine name: Set a unique name for the VM.
   • Size: Choose a VM with at least 2 vCPUs and 4 GiB RAM.

3. Administrator account:

   • Username: Set to
     ubuntu
     .
   • SSH public key source: Generate a new key pair or use an existing one.

4. Inbound port rules:

   • Select inbound ports: Enable ports SSH (22), HTTP (80), and HTTPS (443).

5. Double-check your configuration and click Review + Create to finalize.

1. After the virtual machine is created, retrieve its public IP address:
   • In the Azure Portal, go to Virtual Machines.
   • Select your virtual machine.
   • In the Overview section, find the Public IP address.

2. Use this public IP address to start configuring and accessing the CloudBeaver interface.

3. In your browser, go to

   http://public-IP>/
   , where
   <public-IP>
   is the public IP address of your Azure instance.

4. You’ll be redirected to CloudBeaver’s initial configuration wizard to complete the setup.

Tip: For guidance on locating your instance’s public IP address, see Azure: Find IP Address of a VM.

Note: This feature is available in Enterprise, AWS, Team editions only.

Following products need a license:

• CloudBeaver EE

• CloudBeaver AWS in a custom host

You need to get a license from your profile on https://dbeaver.com/cloudbeaver-enterprise/ web site.
You can use a commercial or trial license. All licenses work the same way.

You add your license when you first start CloudBeaver during Server configuration. Also, it’s possible to return to the Administration panel anytime and import the license. This can be done in two ways: by adding the license text or by uploading the license file. In the first case, please note that you need to copy-paste the full license text (not just the license ID). The license text starts with ‘–’ and ends with ‘==’ characters.

Once you have the license text in the filed, click ‘Import’.

License has an expiration period. Typically it is 1 year.
If your machine has access to internet then license will be updated automatically after you you upgraded it on dbeaver.com.
Otherwise you will need to go to admin panel again and re-install the license.

The instance contains an Nginx proxy server, the configuration of which is located at path

To set up a connection via HTTPS with domain:

• You need to create or buy a valid TLS certificate for your domain endpoint.
• After you get SSL certificate for your domain you must put it to
  /etc/nginx/ssl/fullchain.pem
  as certificate and
  /etc/nginx/ssl/privkey.pem
  as a private key.
• Change
  server_name _;
  in configuration
  /etc/nginx/conf.d/cloudbeaver.conf
  to
  server_name <your-domain>;
• Enter in terminal
  sudo systemctl reload nginx.service
  to reload Nginx proxy
• Now you can open your
  CloudBeaver Server
  from the browser using your domain address.

Self-signed certificates are considered insecure for the Internet. Firefox will treat the site as having an invalid certificate, while Chrome will act as if the connection was plain HTTP

You can create self-signed certificate for

SECRET_CERT_CSR="/C=US/ST=NY/L=NYC/O=CloudBeaver /OU=IT Department/CN=<your-domain>"

cd /etc/nginx/

mkdir ssl

cd ssl

sudo openssl req -x509 -sha256 -nodes -days 36500 -subj "$SECRET_CERT_CSR" -newkey rsa:2048 -keyout privkey.pem -out fullchain.pem

We use CSS Modules for styling components.

import { useState } from 'react';

import { useS, s } from '@cloudbeaver/core-blocks';

import style from './ExampleComponent.m.css';



function ExampleComponent({ className }) {

  const [mode, setMode] = useState('enabled');

  const [status, setStatus] = useState(false);

  const styles = useS(style);



  function handleClick() {

    setStatus(!status);

    if(status) {

      setMode('enabled');

    } else {

      setMode('disabled');

    }

  }



  return (

    <div className={s(styles, { box: true }, className)}>

      <h2 className={s(styles, { header: true })}>This is Header</h2>

      <p className={s(styles, { message: true, status })}>This is message</p>

      <button

        className={s(styles, { switch: true })}

        data-s-mode={mode}

        type="button"

        onClick={handleClick}

      >

        Change status

      </button>

    <div>

  );

}

.box {

  border-radius: 3px;

  border: solid 1px;

}

.header {

  margin: 0;

}

.message {

  padding: 8px;

}

.status {

  color: red;

}

.switch {

  padding: 2px; 4px;

}

.switch[data-s-mode="disabled"] {

  opacity: 0.75;

}

By default CloudBeaver keeps all data on disk in a volume

It makes sense to backup this directly from time time and also before product version upgrade.
To archive entire workspace run

tar czvf backup.tgz /var/cloudbeaver/workspace

or

tar czvf backup.tgz /var/cloudbeaver-ee/workspace

then move

Note: if your server has high load it makes sense to stop it before making a backup. Just run

By default CloudBeaver listens to plain http protocol, processes all static content via the Jetty server and is not load balanced.
All these issues can be resolved by putting a real web server in front of CloudBeaver.
We can use Nginx as the most popular web server.

sudo apt update

sudo apt install nginx

Open the Nginx configuration in your favorite text editor.
The default Nginx config file is

  location / {

    proxy_pass       http://localhost:8978;

    proxy_set_header X-Real-IP $remote_addr;

    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;

    proxy_set_header Host $http_host;

    proxy_http_version 1.1;

    proxy_set_header Upgrade $http_upgrade;

    proxy_set_header Connection "upgrade";

  }

To identify the information (real IP address) of client connected to the web server through NGINX, add the parameter