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.

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

CloudBeaver includes support for Microsoft Entra ID authentication, enabling secure connections to your databases.

Here are the steps to configure Microsoft Entra ID authentication:

1) From the Authentication dropdown menu, select the Microsoft Entra ID method.

2) Click the Authenticate button that appears. You’ll be prompted to log in through Azure.

• Alternatively, log in using the Entra ID identity provider directly.

3) If necessary, provide the Azure Group Name for group-based access.

4) Once you have input database connection details, click the Test button to verify your settings. If everything is configured correctly, CloudBeaver should now be able to connect to your database using the Microsoft Entra ID authentication method.

> Tip: If you check the Save credentials for the current user option, you will not be asked to input your credentials > every time you connect. For more details on connection settings, see Create Connection.

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

CloudBeaver is fully compatible with the MongoDB authentication method, offering you a secure way to access your MongoDB databases.

Here are the steps to configure MongoDB authentication:

1. Start by creating a connection for MongoDB.

2. Enter the username and password in the Username and Password fields respectively.

Tip: If you check the Save credentials for the current user option, you will not be asked to input your credentials every time you connect. For more details on connection settings, see Create Connection.

3. From the Mechanism dropdown menu, select an option. The following table outlines the available authentication mechanisms:

   Mechanism	Description
   SCRAM-SHA-1	A password-based authentication mechanism using SHA-1 hashing algorithm. Suitable for securing data transmissions.
   SCRAM-SHA-256	An upgraded version of SCRAM-SHA-1 , using the stronger SHA-256 hashing algorithm. Offers enhanced security.
   MONGODB-CR	A protocol specific to MongoDB, utilizing a challenge-response mechanism for authentication.
   PLAIN	A simple, unencrypted password-based authentication mechanism. Not recommended for production environments due to security vulnerabilities.
   GSSAPI	Based on the Kerberos protocol, this mechanism offers secure password authentication.
   NONE	No authentication is required. This method should only be used in secure, isolated environments.

You can read more about these mechanisms on the MongoDB documentation page.

4. Fill in the additional fields as necessary.

   Field	Description
   Source	The authentication database to use. Typically, this is admin for administrative users.
   Replica Set	Required when your MongoDB setup includes a replica set.

5. Once you have input your credentials, click the Test button to verify your settings. If everything is configured correctly, CloudBeaver should now be able to connect to your database using the MongoDB authentication method.

Anonymous Access Configuration in CloudBeaver enables users to interact with databases without authentication. There are two methods for setting up anonymous access:

• Administrator defined connections: Administrators can configure connections that are accessible anonymously, allowing access to these predefined connections.

• Private connections: When enabled, this feature lets anonymous users configure their private connections from the main page. These connections are temporary and expire with the session.

By adhering to the settings below, CloudBeaver can be configured to allow anonymous access through both administrator-defined and user-customized connections.

Important: If the Allow anonymous access checkbox is not selected, the functionality for anonymous access is disabled, restricting the use of CloudBeaver to authenticated users only.

1. As an administrator, navigate to the Settings -> Server configuration.

2. Locate the Enable private connections option and activate this setting to allow the creation of connections by anonymous users.

   

3. Save changes.

Note: Connections created by anonymous users are not permanent. These connections will be terminated following the session expiration.

1. Start the process of creating a connection as an administrator. For detailed instructions, refer to the Create Connection article.

2. Navigate to the Access tab within the connection settings and click on the Edit button to modify access settings.

   

3. Choose

   user
   (representing all users, including anonymous) from the list and click Add to include this user group in the access rights.

   

4. Once all the connection settings are configured, click the Create button to establish the new connection.

Note: If the administrator has enabled the Enable private connections option, anonymous access cannot be configured for that specific database.

CloudBeaver includes support for Database Native authentication, enabling secure connections to your databases.

Here are the steps to configure Database Native authentication:

1) From the Authentication dropdown menu, select the Database Native method. 2) Enter the username and password that are associated with your database in the Username and Password fields respectively.

Tip: If you check the Save credentials for the current user option, you will not be asked to input your credentials every time you connect. For more details on connection settings, see Create Connection.

3) Once you have input your credentials, click the Test button to verify your settings. If everything is configured correctly, CloudBeaver should now be able to connect to your database using the Database Native authentication method.

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

Users can be provisioned from the third-party system. This is useful when you want to pre-configure access for users.

Supported providers:

1. Microsoft AzureAD
2. Okta OpenID
3. Google OpenID

You can find the

Click on this button will open users importing form.

To import users, you need to select users provisioning provider and click

You will be asked to log in with the selected provider (in case you haven’t logged in before) to load users.

After loading users, You can select users to import and verify them in the table on the right side. To confirm importing, click on the

Upon launching the application for the first time, it necessitates an initial setup process. This setup primarily involves configuring specific aspects of the application to ensure optimal functionality.

The initial configuration is a vital step to ensure that the application functions correctly and according to your preferences.

The base application settings require specific essential configurations on initial launch. This includes the following components: administrator account, server info, and base application behavior.

After the initial server configuration, you can log in as an administrator:

• If the authentication is enabled: Settings (top right corner, the cog icon) -> login

• Another option is to enter the

  /#/admin
  page

  

If you see the error “Unsupported authentication provider: local” then you need to enable local authentication in the server configuration and restart the server: Server Configuration Documentation:

"enabledAuthProviders": [

  "local"

]

After successful authentication with the administrator account, you can enter the Administration page:

• via menu: Settings (top right corner, the cog icon) -> Administration

• Directly go to

  /#/admin
  page

On the administration page, select the Connection Templates tab. On the Connection Templates tab, you can create or delete templates. You can read more about it here.

On the administration page, select the Users and Teams tab. On the Users tab, you can create, delete, and edit users. You can read more about it here.

On the administration page, select the Server configuration tab. On the Server configuration tab, you can edit the base application settings. You can read more about it here.

On the administration page, select the Preferences tab. On the Preferences tab, you can customize settings for the interface, Data Viewer, SQL Editor, and Tools. You can find initial guidelines in Preferences article.

CloudBeaver Community Edition Edition supports many popular databases out of the box. However, there are instances where you need to add a new driver, especially if the database is less popular or if a custom driver has been developed by your company.

This instruction describes how you can add a custom database driver to CloudBeaver Community Edition Edition.

CloudBeaver Community Edition is based on the DBeaver platform. It reuses drivers provided by DBeaver plugins.
Thus, you cannot add a driver which is not configured in some DBeaver plugins.

Out of the box, DBeaver supports more than 50 different database drivers. Some of them are pre-configured in CloudBeaver Community Edition as well, and some are not.
Generally, adding a new driver in CloudBeaver Community Edition consists of two steps:

1. Add driver in DBeaver
2. Configure this driver in CloudBeaver Community Edition

If a driver is already included in DBeaver, then you can skip the first step.

DBeaver downloads database drivers (JDBC) on demand (after the first attempt to connect to the database). This approach does not work in CloudBeaver Community Edition, mostly because the driver download may require some user interactions + access to external resources + some local file system permissions.
CloudBeaver Community Edition must have all driver jars pre-downloaded in the folder set as

The driver descriptions are usually located in the DBeaver’s

    <extension point="org.jkiss.dbeaver.dataSourceProvider">

        <datasource id="postgresql" label="PostgreSQL" ...>

            ....



            <drivers managable="true">

                ...

                <driver

                    id="postgres-jdbc"

                    label="PostgreSQL"

                    icon="icons/postgresql_icon.png"

                    iconBig="icons/postgresql_icon_big.png"

                    class="org.postgresql.Driver"

                    sampleURL="jdbc:postgresql://{host}[:{port}]/[{database}]"

                    useURL="true"

                    defaultPort="5432"

                    defaultDatabase="postgres"

                    defaultUser="postgres"

                    webURL="https://jdbc.postgresql.org/"

                    propertiesURL="https://jdbc.postgresql.org/documentation/head/connect.html#connection-parameters"

                    description="%driver.postgresql.description"

                    categories="sql">

                    <file type="jar" path="maven:/org.postgresql:postgresql:RELEASE[42.2.25]" bundle="!drivers.postgresql" />

                    <file type="jar" path="drivers/postgresql" bundle="drivers.postgresql" />



                    <parameter name="serverType" value="postgresql" />

                    <property name="loginTimeout" value="20" />

                    <property name="connectTimeout" value="20" />

                </driver>

                ...

            </drivers>

        </datasource>

    </extension>

It is the actual PostgreSQL driver definition (irrelevant configuration elements were skipped).
The full driver ID is

Note: for most non-standard drivers, you must add a new driver definition to the Generic plugin (

You can add a new driver configuration manually in the plugin.xml. But you can also generate this configuration in the DBeaver user interface.

Adding custom driver configuration in the UI is described here: Database Drivers.
After that, you can find your driver definition in the

All drivers need some 3rd party jar files (actual driver executable code).
For CloudBeaver Community Edition, 3rd party jars must be in a public Maven repository (Maven Central is preferred). Line

<file type="jar" path="maven:/org.postgresql:postgresql:RELEASE[42.2.25]">

refers to an external Maven artifact that must contain the driver jar files.

In the driver definition example (see above), you can see two lines:

<file type="jar" path="maven:/org.postgresql:postgresql:RELEASE[42.2.25]" bundle="!drivers.postgresql" />

<file type="jar" path="drivers/postgresql" bundle="drivers.postgresql" />

The first one refers to the actual Maven artifact. The Second one refers to some weird path

After you add your new driver in plugin.xml, you must be able to connect to your database in DBeaver UI by choosing your new driver in the new connection wizard:

• Build the DBeaver desktop app (run
  mvn clean package
  in the root folder).
• Run the dbeaver executable in the product/standalone/target/products/…/dbeaver folder (path differs for different OSes).
• Open the “New Connection” wizard. Configure your connection and click the “Test Connection” button.

If everything is fine then you can create a Pull Request and contribute your changes in the main DBeaver repository. This part is optional, you can leave everything in your local version or your forked version of DBeaver. In this case, you will need to fix the CloudBeaver Community Edition build script (the default build script uses the main dbeaver repository as a platform source code).

Tip: For detailed guidelines, see Contribution Guide.

You need to configure the driver in CloudBeaver Community Edition separately because it does not include all existing drivers from DBeaver.

You must include a driver in the server build. All 3rd party jars must be available for the server during the startup. By default, the CloudBeaver Community Edition build script downloads 3rd party jars from Maven Central, but you can add a custom logic there.

• Explore directory server/drivers.
• Create a new sub-folder
  new-driver-id
  . You can copy-paste some existing driver directory for simplification.
• Add the
  pom.xml
  file to the new directory. It is a standard Maven pom. It can look like this:

  
  <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  
    <modelVersion>4.0.0</modelVersion>
  
    <artifactId>drivers.postgresql</artifactId>
  
    <version>1.0.0</version>
  
    <parent>
  
        <groupId>io.cloudbeaver</groupId>
  
        <artifactId>drivers</artifactId>
  
        <version>1.0.0</version>
  
        <relativePath>../</relativePath>
  
    </parent>
  
    <properties>
  
        <deps.output.dir>new-driver-id</deps.output.dir>
  
    </properties>
  
    <dependencies>
  
        <dependency>
  
            <groupId>new.driver.vendor</groupId>
  
            <artifactId>new-driver-artifact.id</artifactId>
  
            <version>new-driver-artifact-version</version>
  
        </dependency>
  
    </dependencies>
  
  </project>
  
  

• Add your new driver id (equal to the new directory name) to the main server/drivers/pom.xml in the

  <modules>
  section.

• Open file server/bundles/io.cloudbeaver.resources.drivers.base/plugin.xml
• Add line
  <resource name="drivers/new-driver-id" />
  in the end of other resource references. It will tell CloudBeaver where to find your new driver’s jars.
• Add line
  <bundle id="drivers.new-driver-id" label="New driver files" />
  in the end of bundle list. See bundle configuration description for explanation.
• Add line
  <driver id="full-driver-id" />
  in the end of the enabled drivers list. Usually, your full driver ID will be something like
  generic.new-driver-id
  , and the new-driver-id must match the ID in DBeaver’s plugin.xml file.

That’s it.

See Build and deploy. Then just run the

If you’ve forgotten the admin password for CloudBeaver, follow these steps to reset it:

1. Access the workspace directory used by the Docker container.
2. Look for the file named
   .cloudbeaver.runtime.conf
   in the
   .data
   subdirectory.

Tip: For more information on locating the workspace directory, see Workspace location.

1. Open
   .cloudbeaver.runtime.conf
   in a text editor.
2. Locate the line that begins with:

   
   "serverName": ...
   
   

3. Delete this line completely.
4. Save and close the file.

Run the following commands:

docker stop <container-name>

docker start <container-name>

Tip: For general Docker commands, see the Docker CLI reference.

docker-compose stop

docker-compose start

1. Access the CloudBeaver setup wizard in your browser at
   http://<your-server-ip>:8978
   .

2. The initial server setup wizard will open, allowing you to configure the admin password along with other settings.

   Note: Your license, configured connections, and other settings will remain unchanged.

3. Once complete, the admin password is reset and your server will be ready for use.