CloudBeaver Enterprise deployment

Version 26.0

CloudBeaver Enterprise is a client-server application. It requires server deployment. You can deploy it in several ways:

• With Docker Compose
• With a single Docker image
• With Kubernetes/Helm

Installation with Docker Compose

It is the simplest way to install CloudBeaver Enterprise Edition.
All you need is a Linux, macOS, or Windows machine with Docker.

CloudBeaver can be run in a single docker container.
However you can use Docker compose for easy web server (HTTPS) configuration.

System requirements

• Minimum 4GB RAM
• Minimum 50GB storage, > 100GB recommended
• Ubuntu recommended
• Docker installed. Make sure you have chosen the right OS distro.
• docker-compose binary installed and added to your PATH variable. Supported versions 2.10 and above
  • If you install docker-compose-plugin, you must use the docker compose command instead of docker-compose.

Configuring proxy server (Nginx / HAProxy)

Starting from v25.1, CloudBeaver supports two types of proxy servers: Nginx and HAProxy. You can choose your preferred proxy type by setting the following variable in the .env file:

PROXY_TYPE=nginx # Available options: nginx, haproxy

The default value is nginx. Switching between proxy types is seamless: configuration files and SSL certificates are retained due to shared Docker volumes.
However, note that the container name has changed from nginx to web-proxy.

Proxy listen ports

When using Docker Compose with host networking mode (network_mode: host), you may configure proxy ports using these environment variables:

LISTEN_PORT_HTTP=80
LISTEN_PORT_HTTPS=443

These variables specify which ports the proxy listens to inside the container.

Notes for Nginx users

If you use Nginx as your proxy server and customize the COMPOSE_PROJECT_NAME in your .env file, make sure to pass this variable explicitly to the container environment:

environment:
  - COMPOSE_PROJECT_NAME=${COMPOSE_PROJECT_NAME}

This step is only required for Nginx, as HAProxy resolves service names via Docker DNS automatically.

Java tool options

Java does not read system environment variables. To pass Java parameters to the Java process, use the JAVA_TOOL_OPTIONS variable in your .env file.

Example for proxy configuration:

JAVA_TOOL_OPTIONS="-Dhttp.proxy.host=<proxyname> -Dhttps.proxy.host=<proxyname> -Dhttp.proxy.port=<port> -Dhttps.proxy.port=<port>"

Configuring and starting the CloudBeaver cluster

1. Clone repository

   git clone https://github.com/dbeaver/cloudbeaver-deploy

2. Open the configuration file
   • Navigate to cloudbeaver-deploy
   • Copy .env.example to .env
   • Edit the .env file to set configuration properties
   • You must set the CLOUDBEAVER_DB_PASSWORD variable before starting the cluster. The database password is empty by default and the service will not start without it.
3. Start the cluster
   • docker-compose up -d or docker compose up -d
4. Ensure the following TCP ports are available in your network stack
   • 80/tcp
   • 443/tcp (for HTTPS access)
5. Open https://<deployment-machine-ip-address> to access the app. This URL will open the admin panel when the app is first started.

Stopping the cluster

docker-compose down

Using external database

By default, CloudBeaver stores all data in an internal PostgreSQL database. If you want to use it, skip this step.

If you want to use another database, you can configure it by editing the .env file:

1. Change CLOUDBEAVER_DB_DRIVER to driver for a database you want to use, for example: postgres-jdbc/mariaDB/oracle_thin/microsoft
2. Change CLOUDBEAVER_DB_URL to the JDBC connection URL for your database.
3. Set CLOUDBEAVER_DB_USER and CLOUDBEAVER_DB_PASSWORD with your database credentials.

Configure PostgreSQL database

Connect to your Postgres database and run:

CREATE SCHEMA IF NOT EXISTS cb;

Configure MySQL/MariaDB database

Note: The MySQL driver is not included by default. To use MySQL as an internal database, connect using the MariaDB driver.

Connect to your MariaDB or MySQL database and run:

CREATE SCHEMA IF NOT EXISTS cb;

You might need to add additional parameters to the CLOUDBEAVER_DB_URL:

• allowPublicKeyRetrieval=true — to allow the client to automatically request the public key from the server.
• autoReconnect=true — to prevent the connection from closing after 8 hours of inactivity.

Example:

CLOUDBEAVER_DB_URL=jdbc:mariadb://127.0.0.1:3306/cloudbeaver?autoReconnect=true&allowPublicKeyRetrieval=true

Configure Oracle database

Connect to your Oracle database and run:

CREATE USER CB;
GRANT UNLIMITED TABLESPACE TO CB;

Configure SQL Server database

Connect to your SQL Server database and run:

CREATE DATABASE cloudbeaver;

Example:

CLOUDBEAVER_DB_DRIVER=microsoft
CLOUDBEAVER_DB_URL=jdbc:sqlserver://127.0.0.1:1433;databaseName=cloudbeaver

Configuring SSL (HTTPS)

There are two ways to configure SSL:

1. You can configure HTTPS automatically in the admin panel.
   In this case your server domain address will be <deployment-domain>.<organization-domain>.databases.team.
   You can setup organization and deployment domains.
2. You can issue you own SSL cenrtificate and configure it manually by editing nginx config.

Podman requirements

as user root run following commands before Configuring and starting the CloudBeaver cluster:

1. loginctl enable-linger 1000
2. echo 'net.ipv4.ip_unprivileged_port_start=80' >> /etc/sysctl.conf
3. sysctl -p

on step 4 of Configuring and starting the CloudBeaver cluster use podman-compose tool intead of docker-compose and on step 4 define compose file name:

podman-compose -f podman-compose.yml up -d

or replace docker-compose.yml with podman-compose.yml and use podman-compose without compose project definition

Updating the cluster

1. Replace the value of CLOUDBEAVER_VERSION_TAG in .env with a preferred version. If you use the tag latest, you don't need to do anything during this step.
2. Pull new docker images: docker-compose pull or docker compose pull
3. Restart the cluster: docker-compose up -d or docker compose up -d

Installation with Docker image

CloudBeaver Enterprise can run as a single Docker container:

1. Pull Docker image

   docker pull dbeaver/cloudbeaver-ee:latest

   You can replace latest with a preferred version tag. Use the same tag when running the container.

2. Run container

   docker run --name cloudbeaver-ee --rm -ti -p 8978:8978 \
     -v /var/cloudbeaver-ee/workspace:/opt/cloudbeaver/workspace \
     dbeaver/cloudbeaver-ee:latest

   Replace 8978 with a preferred host port.

3. Access application

   Open http://<server-ip>:8978 in a web browser.

Configuring proxy server

Use the official CloudBeaver web proxy for proper HTTPS configuration.

You can choose between Nginx and HAProxy images, or set up web proxy automatically with the Docker Compose deployment.

Note: The Domain Manager is available only when running with a CloudBeaver web proxy setup.

Installation with Kubernetes/Helm

For Kubernetes deployments using Helm charts, see:

• General Kubernetes/Helm deployment guide
• AWS EKS specific deployment guide

User and permissions changes

Starting from CloudBeaver v25.0, the process inside all CloudBeaver Enterprise containers (both Docker Compose and single Docker image) now runs as the ‘dbeaver’ user (‘UID=8978’), instead of ‘root’. If a user with ‘UID=8978’ already exists in your environment, permission conflicts may occur.

Additionally, the default Docker volumes directory’s ownership has changed. Previously, the volumes were owned by the ‘root’ user, but now they’re owned by the ‘dbeaver’ user (‘UID=8978’).

Older versions

Older versions:

• 25.3.0
• 25.2.0
• 25.1.0
• 25.0.0
• 24.3.0
• 24.2.0
• 24.1.0