Docker compose
Note
This deployment method is available in the Enterprise edition only.
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.
Note
CloudBeaver Enterprise's Docker Compose setup includes a pre-configured web service.
For advanced configurations, such as system requirements, ssl configuration, or podman requirements, refer to the Advanced settings guide.
Deploying with host networking
By default, CloudBeaver Enterprise runs using docker-compose.yml
, which uses Docker's bridge network. If you need
containers to run directly on the host network (for example, to bind CloudBeaver to a specific network
interface), use docker-compose-host.yml
.
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
-
Clone the deployment repository:
-
Navigate to the CloudBeaver deploy directory:
-
Set up the
.env
file as described here.Important
You must change the default password in the
.env
file before starting the cluster. -
Start the cluster:
-
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:
Configuring and starting CloudBeaver Enterprise
-
Clone the deployment repository:
-
Navigate to the CloudBeaver deploy directory:
-
Set up the
.env
file as described here.Important
You must change the default password in the
.env
file before starting the cluster. -
Start the cluster:
-
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:
- Verify the installations:
Configuring and starting CloudBeaver Enterprise
-
Clone the deployment repository:
-
Navigate to the deployment directory:
-
Set up the
.env
file as described here.Important
You must change the default password in the
.env
file before starting the cluster. -
Start the cluster:
-
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 |
PROXY_TYPE |
Specifies the proxy server to use. Supported values: nginx , haproxy . For more details on configuring proxy server, see the Proxy configuration. |
haproxy |
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 |