CloudBeaver Enterprise deployment from docker compose

Note: This deployment method is available in the Enterprise edition only.

Table of contents

• Overview
• Installation on Ubuntu
  • Required tools setup
  • Configuring and starting CloudBeaver Enterprise
• Installation on macOS
  • Required tools setup
  • Configuring and starting CloudBeaver Enterprise
• Installation on Windows
  • Required tools setup
  • Configuring and starting CloudBeaver Enterprise
• Update CloudBeaver Enterprise
• Environment file configuration
• Docker Compose Variables
• CloudBeaver Configuration Variables

Overview

CloudBeaver Enterprise can be easily deployed using Docker Compose. This guide provides step-by-step instructions for setting up CloudBeaver Enterprise on Ubuntu, macOS, and Windows.

For advanced configurations, such as system requirements, ssl configuration, or podman requirements, refer to the Advanced settings guide.

Note: CloudBeaver Enterprise's Docker Compose setup includes a pre-configured web service.

Installation on Ubuntu

Required tools setup

• Ensure Docker and Docker Compose are installed by following the Docker installation guide for Linux.
• Install Docker Compose if it’s not already installed.
• Install Git if it’s not already installed.

Configuring and starting CloudBeaver Enterprise

1. Clone the deployment repository:

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

2. Navigate to the CloudBeaver deploy directory:

   cd cloudbeaver-deploy

3. Set up the .env file as described here.

   Important: You must change the default password in the .env file before starting the cluster.

4. Start the cluster:

   docker compose up -d

5. Access CloudBeaver Enterprise at http://<server-ip>.

Tip: Replace <server-ip> with your server’s actual IP address. You can configure the domain during the initial setup. For more details, see Domain Manager.

Installation on macOS

Required tools setup

• Install Docker Desktop for macOS from Docker website. Make sure Docker Desktop is running before proceeding.

• Install Docker Compose if it’s not bundled with Docker Desktop:

  brew install docker-compose

• Install Git if it’s not already installed:

  brew install git

• Verify the installation:

  docker --version
  docker-compose --version
  git --version

Configuring and starting CloudBeaver Enterprise

1. Clone the deployment repository:

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

2. Navigate to the CloudBeaver deploy directory:

   cd cloudbeaver-deploy

3. Set up the .env file as described here.

   Important: You must change the default password in the .env file before starting the cluster.

4. Start the cluster:

   docker-compose up -d

5. Access CloudBeaver Enterprise at http://<server-ip>.

Tip: Replace <server-ip> with your server’s actual IP address. You can configure the domain during the initial setup. For more details, see Domain Manager.

Installation on Windows

Required tools setup

• Install Docker Desktop for Windows from Docker website.

• Install Git if it’s not already installed:

  winget install --id Git.Git -e --source winget

• Verify the installations:

  docker --version
  docker-compose --version
  git --version

Configuring and starting CloudBeaver Enterprise

1. Clone the deployment repository:

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

2. Navigate to the deployment directory:

   cd cloudbeaver-deploy

3. Set up the .env file as described here.

   Important: You must change the default password in the .env file before starting the cluster.

4. Start the cluster:

   docker-compose up -d

5. Access CloudBeaver Enterprise at http://<server-ip>.

Tip: Replace <server-ip> with your server’s actual IP address. You can configure the domain during the initial setup. For more details, see Domain Manager.

Update CloudBeaver Enterprise

For detailed update instructions, see Update version.

Environment file configuration

The .env file provides configuration settings for CloudBeaver Enterprise. Below are key variables:

Docker Compose Variables

Variable	Description	Default value
IMAGE_SOURCE	Defines the primary source of the Docker image.	dbeaver
PODMAN_IMAGE_SOURCE	Sets the Podman image source.	docker.io/dbeaver
COMPOSE_PROJECT_NAME	Defines the project name for Docker Compose.	dbeaver
CLOUDBEAVER_VERSION_TAG	Specifies the CloudBeaver version to use. See Docker tags.	24.3.0
REPLICA_COUNT_EE	Specifies the number of replicas for Enterprise Edition. See Docker Service Scale Documentation.	1

CloudBeaver Configuration Variables

Variable	Description	Default value
CLOUDBEAVER_WEB_SERVER_PORT	Configures the web server port for CloudBeaver.	8978
CLOUDBEAVER_DB_DRIVER	Sets the database driver. See Server database for details.	postgres-jdbc
CLOUDBEAVER_DB_URL	Provides the database connection URL.	jdbc:postgresql://postgres:5432/cloudbeaver
CLOUDBEAVER_DB_USER	Sets the username for database authentication.	postgres
CLOUDBEAVER_DB_PASSWORD	Sets the password for database authentication.	You must change the default password in the .env file before starting the cluster.
CLOUDBEAVER_DB_SCHEMA	Defines the schema used in the CloudBeaver database.	cb
CLOUDBEAVER_QM_DB_DRIVER	Specifies the database driver for the Query Management (QM) system.	${CLOUDBEAVER_DB_DRIVER}
CLOUDBEAVER_QM_DB_URL	Defines the connection URL for the QM database.	${CLOUDBEAVER_DB_URL}
CLOUDBEAVER_QM_DB_USER	Sets the username for connecting to the QM database.	${CLOUDBEAVER_DB_USER}
CLOUDBEAVER_QM_DB_PASSWORD	Sets the password for authenticating the QM database connection.	${CLOUDBEAVER_DB_PASSWORD}
CLOUDBEAVER_QM_DB_SCHEMA	Defines the schema used in the QM database.	qm
CLOUDBEAVER_DMSVC_URL	Sets the URL of the Domain Manager service.
CLOUDBEAVER_RESTRICT_EXTERNAL_SERVICES_INVOCATION	Blocks outbound calls to the License Manager.	true

For more details on Server configuration, see Server configuration.