To use this method, you need an account on Amazon Marketplace with the following permissions:

• FAWSMarketplaceRead-only

• aws-marketplace:Subscribe on resource

1. Log in to Amazon Marketplace, find CloudBeaver AWS, and press Continue to Subscribe button.

2. Accept DBeaver Corporation offer by pressing Accept Terms and wait for request processing.

Then press Continue to Configuration.

3. Select CloudBeaver version you need in Software version field, select region, and press Continue to Launch.

4. Select the desired configuration:
   • In the EC2 Instance Type select t2.medium or more.
   • In Security group settings, press Create New Based On Seller Settings. Then press Launch.

5. Great! CloudBeaver instance is successfully deployed on EC2.

6. Click EC2 Console link, and you will see the list of your instances. The new instance will be the last one, and without a name.
   • Click on the empty field to give the instance a name.
   • Click on the Instance ID, and you will see the Instance summary.

7. Click on the open address link in the Public IPv4 DNS section.

7. The page in your default web browser will be opened. You need to agree to use the self-signed certificate and change it later. How to change certificate

That’s all done! CloudBeaver Community instance is ready to use. On the first page, you will see the server configuration wizard.

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

See Running from Docker

CloudBeaver EE is an advanced version of the CloudBeaver product. It includes many features of the CloudBeaver Community version, plus numerous enterprise-focused features.

Tip: For a practical demonstration of CloudBeaver’s capabilities, please refer to our demo server. For more information, see Demo Server.

• Relational databases
  • Apache Calcite
  • Apache Drill
  • Apache Ignite
  • Apache Phoenix
  • SQL Server
  • Sybase, SAP ASE
  • DB2
  • Snowflake
  • Databricks
  • Vertica
  • Netezza
  • Hive
  • Google Bigquery
  • Intersystems Cache
  • Clickhouse
  • CockroachDB
  • Dremio
  • DuckDB
  • EnterpriseDB
  • Informix
  • MaxDB
  • Neo4j
  • Oceanbase
  • Opensearch (Elasticsearch)
  • SAP HANA
  • Teradata
  • Timescale
  • Trino
  • Yellowbrick
  • Yugabyte
• NoSQL databases
  • MongoDB
  • Cassandra
  • InfluxDB
  • Couchbase
  • CouchDB
  • Redis
• AWS databases
  • RDS/Aurora
  • Athena
  • Redshift
  • DynamoDB
  • DocumentDB
  • Keyspaces
  • Timestream

CloudBeaver is a web server which provides a rich web interface.
It consists of two parts:

• Server back-end. It is written in Java and reuses “platform” libraries of DBeaver.
• Front-end part. It is written in TypeScript and JavaScript.

This build process is relatively complicated (and also consists of two parts).

Tip: For a practical demonstration of CloudBeaver Enterprise Edition’s capabilities, please refer to our demo server. For more information, see Demo Server.

• Java 17
• Apache Maven (3.9.0+)
• Node.js (20.x)
• Yarn (1.22.x)
• NPM + Lerna

Important: CloudBeaver includes OpenJDK, which is an open-source version of Java. This means you do not need to purchase a separate Java license to use CloudBeaver.

Add Node.js (version 20.x) and Yarn 1.22.x version repo:

  curl -sL https://dl.yarnpkg.com/debian/pubkey.gpg | sudo apt-key add -

  echo "deb https://dl.yarnpkg.com/debian/ stable main" | sudo tee /etc/apt/sources.list.d/yarn.list

  curl -sL https://deb.nodesource.com/setup_18.x | sudo -E bash -

Install packages:

sudo apt update

sudo apt install openjdk-17-jdk

sudo apt install maven

sudo apt install yarn

sudo apt install nodejs

sudo apt install npm

• Download and install AdoptOpenJDK
• Download and extract Maven.
• Add path to Maven bin folder in system PATH
• Download and install Node.js. NPM comes along with Node.js, NPX/Lerna will be installed in the build script.

• Download and install Yarn 1.22.x

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

cd cloudbeaver/deploy

./build.sh

The final artifacts can be found in

cd cloudbeaver

./run-server.sh

By default, the server listens to port

Note: you must be in the server root directory to run it.
If you need to run it from some other directory, then you can set the environment variable

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

Cloud Explorer offers deep integration with popular cloud service providers. As of the latest version, it supports Amazon Web Services (AWS), Google Cloud Platform (GCP), and Microsoft Entra ID (Azure).

With Cloud Explorer, you can set up your cloud access once and then browse, connect, and manage your cloud databases. It saves you from manually configuring each database connection, as it reads all database endpoint information directly from the cloud provider.

Authentication is centralized. You can use your cloud account to access your cloud databases. Before you start using Cloud Explorer, you need to set up your identity provider access. This setup includes access credentials, availability zones for database search, and other cloud-specific settings.

Tip: Use Cloud Storage to manage files and work with

.sql

scripts in your cloud provider.

The Cloud Explorer allows you to connect with and manage various databases:

1. As an administrator, go to Settings -> Administration -> Server Configuration.
2. In the Configuration section, enable the relevant cloud service provider.
3. Save the changes.

Each cloud service provider requires specific settings for the identity provider. Below is a table outlining the basic guides on configuring these settings.

Once you have configured your identity provider, open the Cloud Explorer window to add database connections to your Database Navigator.

1. Navigate to Connection -> Cloud Explorer.

   

2. In the center of the dialog, you will see cloud databases displayed in a hierarchical view. All databases are grouped by database/service type. When you expand one of the top elements, CloudBeaver will search for cloud databases in the configured availability zones/regions.

   

3. Select the cloud service provider. Depending on the type of authentication configured, you may need to log in using the appropriate identity provider in the opened window.

   

4. After authentication, select the database you want to add.

   

   > Tip: If you have a large number of databases in your cloud, you can search for them using the search bar located above the Cloud Explorer.

5. Click on the Create button located in the bottom right corner of the Cloud Explorer dialog. Your database will then appear in the Database Navigator.

You can access your cloud database configuration directly from the Database Navigator. To do this, click on the menu button next to the database you are interested in and select Edit Connection. This action opens a special tab in the connection settings dialog. The information displayed in this tab is specific to the cloud and database type of the selected database.

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

Cloud Storage lets you manage files and work with

1. As an administrator, go to Settings -> Administration -> Server Configuration.
2. In the Configuration section, enable the relevant cloud service provider.
3. Save the changes.

4. Set up the cloud service provider:

   • Cloud (AWS)
   • Cloud (GCP)

Tip: Use preconfigured authentication, like AWS OpenID, to simplify access. For more details, see Authentication methods. In the CloudBeaver AWS Edition, you can use default instance credentials. For more details, see AWS Settings.

After configuring your cloud provider, you can work with the data files. Navigate to Tools -> Cloud Storage to access it.

In the Cloud Storage you can manage files like in a regular file system. Right-click a file or folder to open the context menu and access options such as:

• Upload files from your local storage to a bucket.
• Download files to your local storage.
• Delete or rename files.
• Drag and drop files between buckets or file systems.

Tip: Use the Settings button for additional configuration options. For more details, see the Settings menu.

Cloud Storage allows you to work with

• View and edit the script.
• Execute SQL statements.
• Save changes directly back to Cloud Storage.

CloudBeaver AWS is a web application, that requires server deployment.

• Install Docker 20.10 or higher

• amd64 or arm64 system.

To install the latest version of CloudBeaver AWS use the following script:

docker pull dbeaver/cloudbeaver-aws:latest

To run CloudBeaver AWS in the terminal:

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

Then switch to the browser and open http://localhost:8080/

Add the following parameters:

-d --restart unless-stopped

To use this method, you need an account on Amazon Marketplace with the following permissions:

• FAWSMarketplaceRead-only

1. Log in to Amazon Marketplace, find CloudBeaver AWS, and press Continue to Subscribe button.

Then press Continue to Configuration.

2. Select CloudBeaver version you need in Software version field, select region, and press Continue to Launch.

3. Select the desired configuration:
   • In the EC2 Instance Type select t2.medium or more.
   • In Security group settings, press Create New Based On Seller Settings. Then press Launch.

4. Great! CloudBeaver instance is successfully deployed on EC2.

5. Click EC2 Console link, and you will see the list of your instances. The new instance will be the last one and without a name.
   • Click on the empty field to give the instance a name.
   • Click on the Instance ID, and you will see the Instance summary.

6. Click on the open address link in the Public IPv4 DNS section.

7. The page in your default web browser will be opened. You need to agree to use the self-signed certificate and change it later. How to change certificate

That’s all done! CloudBeaver AWS instance is ready to use. On the first page, you will see the server configuration wizard.

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

CloudBeaver is fully compatible with the PgPass authentication method, offering a secure way to access your PostgreSQL databases. Only an admin can create a PgPass connection.

PostgreSQL’s PgPass method allows authentication using credentials stored in a

1. Create the

   .pgpass
   file. Each line in the file follows the format:

   
   hostname:port:database:username:password
   
   

   Save this line in the

   .pgpass
   file and ensure the file permissions are set to be readable only by the user.

   Tip: For more information on

   .pgpass

   , see PostgreSQL documentation.

2. Open a terminal and run the following command to list Docker containers:

   
   docker ps
   
   

3. Copy the ID of the CloudBeaver container from the list.

4. Transfer the

   .pgpass
   file to the container:

   
   docker cp .pgpass "<container-id>":/root/.pgpass
   
   

   Note: This command is for Linux systems. Ensure the

   .pgpass

   file is placed in the

   /root

   directory.

After transferring the

1. Open CloudBeaver and start creating a connection.
2. In the Authentication dropdown menu, select PostgreSQL PgPass.
3. Enter the username associated with the PostgreSQL database in the Username field.
4. Test the connection by clicking the Test button. If the
   .pgpass
   file is properly configured and the credentials are correct, CloudBeaver will connect successfully.