This guide explains how to create a custom plugin for CloudBeaver. It walks you through the process of adding a simple button to the application’s top bar.

Follow these steps to create a custom plugin that adds a button to the top bar and logs

• Inside

  /webapp/packages
  , create a folder with your desired name, e.g.,
  plugin-hello-world
  .

• Copy the following files from any existing package into your plugin folder:

  • .gitignore
  • package.json
  • tsconfig.json

• Open
  package.json
  and update the
  name
  field to your plugin’s name,
  @cloudbeaver/plugin-hello-world
  .

• Remove the

  dependencies
  and
  devDependencies
  sections.

• Remove the

  references
  section from
  tsconfig.json
  .

• Inside your plugin folder, create a
  src
  folder.
• Add two files in
  src
  :
  • index.ts
  • manifest.ts

• Export the manifest from

  index.ts
  :

  
  export * from './manifest.js';
  
  

• Create a service to add the button.
• It should:
  • Be an injectable class.
  • Extend the
    Bootstrap
    class.
• Add a
  register
  method and implement the button-adding logic.

Example service:

import { Bootstrap, injectable } from '@cloudbeaver/core-di';

import { ActionService, MenuService } from '@cloudbeaver/core-view';

import { MENU_APP_ACTIONS } from '@cloudbeaver/plugin-top-app-bar';

import { ACTION_HELLO_WORLD } from './ACTION_HELLO_WORLD.js';



@injectable()

export class HelloWorldService extends Bootstrap {

  constructor(

    private readonly actionService: ActionService,

    private readonly menuService: MenuService,

  ) {

    super();

  }



  override register(): void {

    this.menuService.addCreator({

      menus: [MENU_APP_ACTIONS],

      getItems: (context, items) => [...items, ACTION_HELLO_WORLD],

    });



    this.actionService.addHandler({

      id: 'hello-world-handler',

      actions: [ACTION_HELLO_WORLD],

      handler: (context, action) => {

        switch (action) {

          case ACTION_HELLO_WORLD: {

            console.log('Hello, World!');

            break;

          }

        }

      },

    });

  }

}

Create the

import { createAction } from '@cloudbeaver/core-view';



export const ACTION_HELLO_WORLD = createAction('hello-world', {

  label: 'Hello, world!',

});

Register your service in

import type { PluginManifest } from '@cloudbeaver/core-di';



export const helloWorldPlugin: PluginManifest = {

  info: {

    name: 'Hello World Plugin',

  },

  providers: [() => import('./HelloWorldService.js').then(m => m.HelloWorldService)],

};

Open

import { helloWorldPlugin } from '@cloudbeaver/plugin-hello-world';



const PLUGINS: PluginManifest[] = [

  ...existingPlugins,

  helloWorldPlugin,

];

In

yarn run update-ts-references

yarn

yarn run update-ts-references

Your button should now appear in the top bar and log

This article explains how to set up and manage pre-configured database connections for the CloudBeaver server. These connections are defined by the administrator and stored on the server, making them unmodifiable by end users. Users can choose from these pre-configured connections directly through the main CloudBeaver toolbar and only need to provide their username and password to access the datasource; no other parameters are necessary.

For information about server and workspace configuration, see Server configuration.

All project-level configurations are located in the

This file contains the settings for each pre-configured connection, allowing the CloudBeaver server to manage and display these connections.

Example configuration:

{

  "folders": {

  },

  "connections": {

    "dbeaver-sample-database-sqlite-1": {

      "provider": "sqlite",

      "driver": "sqlite_jdbc",

      "name": "DBeaver Sample Database (SQLite)",

      "save-password": true,

      "show-system-objects": true,

      "configuration": {

        "database": "/Users/user/Library/DBeaverData/workspace6/.metadata/sample-database-sqlite-1/Chinook.db",

        "url": "jdbc:sqlite:/Users/user/Library/DBeaverData/workspace6/.metadata/sample-database-sqlite-1/Chinook.db",

        "configurationType": "MANUAL",

        "type": "dev",

        "closeIdleConnection": true

      }

    }

  }

}

Tip: This file follows the same format as the DBeaver datasources configuration file. You can create this configuration in DBeaver and then copy it to your CloudBeaver server.

Please note: This article has been updated and its content is now available in a revised form at a new location. Please refer to the updated article Create Connection for the most current information.

Important: This feature will be removed in version

25.0

.

The templates enable administrators to define various reusable connection parameters, subsequently allowing users to create multiple connections based on these templates. This process ensures consistency across the connections created from these templates, as they adhere to the defined parameters within the templates.

You can add, edit, or remove database templates on the

To create a new template, follow the steps below:

1. Click the
   Add
   button located on the top toolbar. This will open the template creation form.
2. Fill out the fields in the form with the appropriate information.
3. Once all fields are completed, click
   Create
   .

Your new template should be successfully created and it will appear at the top of the templates table.

Below are the detailed steps to set the template parameters:

1. Open the template form. This can be done by clicking the
   Add
   button in the toolbar.
2. Fill in the appropriate information in the base template parameters, driver settings, SSH tunnel, and access fields.
3. To verify the template connection, click the
   Test
   button. If SSH is configured, the test will use it to establish the connection.
4. When users attempt to establish a connection using the template, they will be prompted to enter credentials.

You can manage access to the database at the

Once a template is prepared, connections can be created using the template from the public section of the CloudBeaver.

1. In the toolbar, select Connection.
2. From the dropdown menu, select From a template.
3. Choose the desired template.

CloudBeaver support the same system parameters as DBeaver.

There are two ways to pass command line parameters to CloudBeaver server

• Modify
  run-server.sh
  script, add extra parameters after
  java
  command in last line. For example, add parameter
  -Xmx2048
  in server start:

  
  java -Xmx2048M -jar ${launcherJar} -product io.cloudbeaver.product.ce.product -web-config conf/cloudbeaver.conf -nl en -registryMultiLanguage
  
  

Note: to be able to modify run script you must build CloudBeaver from sources. It doesn’t make sense to modify the script in docker container because all changes will be reset after container restart.

Set variable

export JAVA_OPTS=-Xmx2048

./run-server.sh

You can pass JAVA_OPTS variable to docker container by using

sudo docker run -d --restart unless-stopped -p 80:8978 \

  -e JAVA_OPTS=-Xmx2048 \ 

  -v /var/cloudbeaver/workspace:/opt/cloudbeaver/workspace dbeaver/cloudbeaver:latest`}

IMPORTANT: You must replace

1. Open the terminal and navigate to the workspace directory

2. Type the following commands:

   1. openssl genrsa -des3 -passout pass:1 -out {your domain}.pass.key 2048
   2. openssl rsa -passin pass:1 -in {your domain}.pass.key -out {your domain}.key
   3. rm {your domain}.pass.key
      (or
      del {your domain}.pass.key
      on Windows)
   4. openssl req -key {your domain}.key -sha256 -new -out {your domain}.csr
   5. openssl x509 -req -days 3650 -in {your domain}.csr -signkey {your domain}.key -out {your domain}.crt
   6. openssl pkcs12 -export -in {your domain}.crt -inkey {your domain}.key -out {your domain}.p12 -name {your domain} -passout pass:{your password}
   7. keytool -importkeystore -deststorepass {your password} -destkeypass {your password} -destkeystore {your domain}.keystore -srckeystore {your domain}.p12 -srcstoretype PKCS12 -srcstorepass {your password} -alias {your domain}

3. Create a new file called

   ssl-config.xml
   in the
   .data
   directory inside the workspace with the following content:

<!DOCTYPE Configure PUBLIC "-//Jetty//Configure//EN" "http://www.eclipse.org/jetty/configure_10_0.dtd">

<Configure id="Server" class="org.eclipse.jetty.server.Server">

    <New id="httpConfig" class="org.eclipse.jetty.server.HttpConfiguration">

        <Set name="sendServerVersion">false</Set>

        <Set name="sendDateHeader">false</Set>

    </New>



    <Call name="addBean">

        <Arg>

            <New id="sslContextFactory" class="org.eclipse.jetty.util.ssl.SslContextFactory$Server">

                <Set name="keyStorePath">

                    {Full path to your keystore. Example: /opt/cloudbeaver/workspace/cb_keys/domain.test.keystore}

                </Set>

                <Set name="keyStorePassword">

                    {The password you specified when creating certificates}

                </Set>

                <Set name="trustStorePath">

                    {Full path to your keystore example: /opt/cloudbeaver/workspace/cb_keys/domain.test.keystore}

                </Set>

                <Set name="trustStorePassword">

                    {The password you specified when creating certificates}

                </Set>

                <Set name="IncludeProtocols">

                    <Array type="String">

                        <Item>TLSv1.2</Item>

                    </Array>

                </Set>

                <Set name="IncludeCipherSuites">

                    <Array type="String">

                        <Item>TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384</Item>

                        <Item>TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384</Item>

                    </Array>

                </Set>

                <New id="tlsHttpConfig" class="org.eclipse.jetty.server.HttpConfiguration">

                    <Arg>

                        <Ref refid="httpConfig" />

                    </Arg>

                    <Call name="addCustomizer">

                        <Arg>

                            <New class="org.eclipse.jetty.server.SecureRequestCustomizer">

                                <Set name="sniHostCheck">false</Set>

                            </New>

                        </Arg>

                    </Call>

                </New>

            </New>

        </Arg>

    </Call>



    <Call id="sslConnector" name="addConnector">

        <Arg>

            <New class="org.eclipse.jetty.server.ServerConnector">

                <Arg name="server">

                    <Ref refid="Server" />

                </Arg>

                <Arg name="factories">

                    <Array type="org.eclipse.jetty.server.ConnectionFactory">

                        <Item>

                            <New class="org.eclipse.jetty.server.SslConnectionFactory">

                                <Arg name="next">http/1.1</Arg>

                                <Arg name="sslContextFactory">

                                    <Ref refid="sslContextFactory" />

                                </Arg>

                            </New>

                        </Item>

                        <Item>

                            <New class="org.eclipse.jetty.server.HttpConnectionFactory">

                                <Arg name="config">

                                    <Ref refid="tlsHttpConfig" />

                                </Arg>

                            </New>

                        </Item>

                    </Array>

                </Arg>

                <Set name="port">

                    8978

                </Set>

                <Set name="idleTimeout">

                    <Property name="jetty.idleTimeout" default="30000" />

                </Set>

            </New>

        </Arg>

    </Call>

</Configure>

4. Start the application using the following command:
   • In docker:
     docker run --name={container name} -p 8978:8978 -ti -v {absolute path to workspace}:/opt/cloudbeaver/workspace dbeaver/cloudbeaver-ee:{container name}
   • From sources:
     ./run-server.sh