Keep your CloudBeaver Enterprise server up to date to access the latest features, improvements, and security patches.

Warning: Always backup your workspace before updating. Downgrades are not supported.

Tip: For detailed instructions, see the Docker CLI Documentation and Docker Compose Documentation.

To update a cluster, managed with Docker Compose:

1. Update the value of

   CLOUDBEAVER_VERSION_TAG
   in your
   .env
   file to the desired version. If using the
   latest
   tag, skip this step.

2. Pull the latest changes for

   cloudbeaver-deploy
   (Optional):

   
   git pull
   
   

3. Pull new Docker images:

   
   docker-compose pull
   
   

4. Restart the cluster:

   
   docker-compose up -d
   
   

To update using a standalone Docker image:

1. Stop and remove the existing container:

   
   docker stop cloudbeaver-ee
   
   docker rm cloudbeaver-ee
   
   

2. Pull the new image:

   
   docker pull dbeaver/cloudbeaver-ee:latest
   
   

3. Run the updated container:

   
   docker run --name cloudbeaver-ee -d --restart unless-stopped -p 8978:8978 -v /var/cloudbeaver-ee/workspace:/opt/cloudbeaver/workspace dbeaver/cloudbeaver-ee:latest
   
   

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

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.

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

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.

• 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
  
  

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.

• 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
  
  

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.

For detailed update instructions, see Update version.

The

For more details on Server configuration, see Server configuration.

This guide provides step-by-step instructions for deploying CloudBeaver Community on Amazon Web Services Marketplace.

1. Log in to Amazon Marketplace. Search for
   cloudbeaver community
   , then select CloudBeaver Community.

2. Click Launce new instance.

3. Configure your software contract, then click Continue to launch through EC2.

4. Select the required CloudBeaver version in the Software version field, choose your region, and click Continue to Launch.

5. In Instance Type, select

   t2.medium
   or higher.

6. (Optional) Select or create a new key pair to access the instance later via SSH.

7. Set up your Network settings:

   • For security reasons, it’s recommended not to make the instance publicly accessible.

   • Limit inbound traffic to specific traffic from IPs (e.g., your office IP address) or subnets and only open the necessary ports:

     • Allow SSH traffic (Optional): 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.

8. Click Launch instance.

1. In your browser, go to

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

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

CloudBeaver is a client-server application that requires server deployment. You can deploy it on a single host or in the cloud, depending on your needs.

CloudBeaver Community Edition can be deployed on various platforms and environments:

• Docker image
• AWS Marketplace
• Google Cloud
• Microsoft Azure

This guide explains how to deploy CloudBeaver Community 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-ce
   . 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.

6. Begin the initial setup of the CloudBeaver server in your browser.

1. In your browser, go to

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

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

This guide covers how to deploy CloudBeaver Community Edition 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 Community Edition 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-ce-server-ubuntu-%version%
     or
     cloudbeaver-ce-server-rhel-%version%
     , depending on the operating system.
   • Select Virtual disk (VMDK, VHD) as the source and enter the following URI:
     cloudbeaver-ce-server/
     in the Virtual disk file field. Click BROWSE to select your version.

   > Tip: Replace

   %version%
   with the desired version number, such as
   24-2-0
   .

3. Click Create. The image import process can 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.

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-ce-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-ce-ubuntu-24-2-0 \

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

--boot-disk-size=100GB --boot-disk-device-name=cloudbeaver-ce-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):

   `
   bash gcloud compute instances list –filter=”name:cloudbeaver-ce-server” –format=”get(networkInterfaces[0].accessConfigs[0].natIP)”
   `

   This command will return the

   external-ip
   , which you’ll need to begin the initial setup.

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-ce-ubuntu-%version%
• https://www.googleapis.com/compute/v1/projects/dbeaver-public/global/images/cloudbeaver-ce-rhel-%version%

Tip: Replace

%version%

with the desired version number, such as

24-2-0

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

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

This guide provides step-by-step instructions for deploying CloudBeaver AWS on Amazon Web Services Marketplace.

1. Log in to Amazon Marketplace. Search for

   cloudbeaver aws
   , then select CloudBeaver AWS.

2. Click Launce new instance.

3. Configure your software contract, then click Continue to launch through EC2.

4. Select the required CloudBeaver version in the Software version field, choose your region, and click Continue to Launch.

5. In Instance Type, select

   t2.medium
   or higher.

6. (Optional) Select or create a new key pair to access the instance later via SSH.

7. Set up your Network settings:

   • For security reasons, it’s recommended not to make the instance publicly accessible.

   • Limit inbound traffic to specific traffic from IPs (e.g., your office IP address) or subnets and only open the necessary ports:

     • Allow SSH traffic (Optional): 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.

8. Click Launch instance.

1. In your browser, go to

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

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

CloudBeaver Community is available for deployment via a Docker image.

Follow these steps to deploy CloudBeaver using Docker:

For additional configuration details, refer to the Docker documentation.

1. Pull the latest CloudBeaver image from DockerHub:

   `
   sh docker pull dbeaver/cloudbeaver:latest
   `

   > For a specific version, replace

   latest
   with the desired version tag. For more details on version tags, see Docker tags.

2. Run the Docker container:

   `
   sh docker run –name cloudbeaver –rm -ti -p 8978:8978 -v /var/cloudbeaver/workspace:/opt/cloudbeaver/workspace dbeaver/cloudbeaver:latest
   `
   • Replace the first port argument
     8978
     with the port you want to use on the host machine.
   • Ensure the directory
     /var/cloudbeaver/workspace
     exists and is writable for data persistence.
   • (Optional) If you’re using a proxy, you can set the IP address manually:
   `
   sh docker run –name cloudbeaver –rm -ti -p 127.0.0.1:8978:8978 -v /var/cloudbeaver/workspace:/opt/cloudbeaver/workspace dbeaver/cloudbeaver:latest
   `

   To keep the container running in the background (daemon mode), add:

   `
   sh –restart unless-stopped
   `

3. Access the application:

    http://<server-ip>:8978

4. Access

   <server-ip>
   databases

   To access a database running on the host machine from the container (Linux only), use:

   `
   sh –network host
   `

   Alternatively, pass the host IP address:

   `
   sh –add-host=host.docker.internal:
   `

Warning: Always backup your workspace before updating. Downgrades are not supported.

To update using a standalone Docker image:

1. Stop and remove the existing container:

   
   docker stop cloudbeaver
   
   docker rm cloudbeaver
   
   

2. Pull the new image:

   
   docker pull dbeaver/cloudbeaver:latest
   
   

3. Run the updated container:

   
   docker run --name cloudbeaver -d --restart unless-stopped -p 8978:8978 -v /var/cloudbeaver/workspace:/opt/cloudbeaver/workspace dbeaver/cloudbeaver:latest
   
   

If deploying on a server without internet access:

1. Archive the Docker image on a machine with internet:

   
   docker save dbeaver/cloudbeaver | gzip > cloudbeaver.tar.gz
   
   

2. Transfer the archive to the target server.
3. Load the image:

   
   docker load < cloudbeaver.tar.gz
   
   

4. Run the container as described above.

CloudBeaver uses the Jetty server for web application hosting. If you need to configure HTTPS for secure communication, refer to the Jetty configuration guide for detailed instructions.

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

CloudBeaver AWS 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-aws
   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 traffic from IPs (e.g., your office IP address) or subnets and only open the necessary ports:

     • Allow SSH traffic (Optional): 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. (Optional) Select or create a new key pair to access the instance later via SSH.
3. Click Launch instance.
4. Once the instance launches, monitor its status in the EC2 dashboard.
5. Begin the initial setup of the CloudBeaver.

1. In your browser, go to

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

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