This article explores the release cycles and support periods, detailing how we organize software updates and support.

CloudBeaver releases updates on a structured schedule, providing users with regular enhancements, new features, and fixes.

• Regular releases: CloudBeaver releases a new stable version every three months, resulting in four major updates annually.
• Early Access (EA) versions: Additionally, CloudBeaver provides Early Access (EA) versions every two weeks. These versions allow users to engage with upcoming features and changes, offering feedback to help refine these enhancements before their official release.

Important: The EA version may not be as stable as the regular releases. Users are advised to use EA versions with caution.

The following tags determine the version you install on your machine:

• ea
  : The tag
  ea
  is associated with the latest Early Access (EA) version that has been released.
• latest
  : The
  latest
  tag points to the most recent stable version.
• Versions with the specific numbers:
  • xx.0.1
    : Specifying a version in this format will download the exact version of the CloudBeaver.
  • xx.0
    : Using a version number formatted as
    xx.0
    will download the latest version within the
    xx.0
    series.
  • xx
    : Specifying just the major version number, like
    24
    will download the latest version within the major version
    24
    family.

Tip: Instruction for deploying CloudBeaver using Docker images can be found in our article.

The following comparison table details the specific differences between Annual and Perpetual subscription. You can view your license type in on the website: https://dbeaver.com/profile/.

Note: The primary distinctions between perpetual and annual subscriptions are tied to the Duration of access. While Perpetual license holders can use CloudBeaver indefinitely with the last update received, Annual subscribers need to renew their subscription to access CloudBeaver.

As we have several service types, we want to reflect these types in the file name. It will allow us to easily determine the purpose of usage.

Default service (general-purpose, application business logic):

Resource service (state management):

Bootstrap service (application initiation logic):

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

Cognito OpenID Authentication provides a robust solution for managing user authentication and access in applications. By integrating with Amazon Cognito, it utilizes the OpenID Connect protocol to offer a secure and scalable user management system. This method simplifies the authentication process. For detailed instructions on setting up Cognito OpenID, it is advisable to consult the official Amazon Cognito documentation.

1. As an administrator, go to Settings -> Server Configuration.

2. Find the AWS option (in the Configuration section) and Cognito OpenID (in the Authentication Settings section). Activate this setting to enable Cognito OpenID authentication.

   

3. Save the changes.

1. As an administrator, navigate to Settings -> Identity Providers.

2. Click on the + Add button.

3. Fill in the following fields:

   

   Field	Description
   Provider	Select Cognito OpenID from the dropdown menu.
   ID	Enter a unique identifier for the configuration.
   Configuration name	Enter a descriptive name for this configuration.
   Description	Provide a brief description of this identity provider configuration.
   Icon URL	Enter the URL of an icon to represent this provider.
   Disabled	Leave unchecked to enable this identity provider.
   Client ID	The client identifier provided by the OpenID Connect provider.
   Client Secret	A secret key associated with the client ID for authentication.
   IDP auth endpoint URL	The endpoint for initiating the authentication process.
   IDP token endpoint URL	The endpoint for obtaining access and refresh tokens.
   IDP userinfo endpoint URL	Fill in with the endpoint URL found in the Amazon Cognito User Pool under “App integration”.
   Region	Specify the AWS region of your Cognito User Pool.
   Identity pool ID	Enter the ID of your Cognito Identity Pool.
   Custom role ARN	Provide ARN of the role that will be used by the users during authorization.

4. Click on the Create button.

5. Copy Redirect and Sign out Links:

   1. Enter the newly created identity provider.
   2. Copy the Redirect link and the Sign out link.

6. Update Redirect URIs in Amazon Cognito.

1. With the Cognito OpenID configuration now established, proceed to the login screen.

2. Select the Federated authentication method, labeled with the Configuration name you specified.

   

3. Clicking on this authentication method will redirect you to the Sign in with Google page.

4. After selecting the necessary account, you will be automatically redirected and logged into the CloudBeaver.

The instance contains an Nginx proxy server, the configuration of which is located at path

To set up a connection via HTTPS with domain:

• You need to create or buy a valid TLS certificate for your domain endpoint.
• After you get SSL certificate for your domain you must put it to
  /etc/nginx/ssl/fullchain.pem
  as certificate and
  /etc/nginx/ssl/privkey.pem
  as a private key.
• Change
  server_name _;
  in configuration
  /etc/nginx/conf.d/cloudbeaver.conf
  to
  server_name <your-domain>;
• Enter in terminal
  sudo systemctl reload nginx.service
  to reload Nginx proxy
• Now you can open your
  CloudBeaver Server
  from the browser using your domain address.

Self-signed certificates are considered insecure for the Internet. Firefox will treat the site as having an invalid certificate, while Chrome will act as if the connection was plain HTTP

You can create self-signed certificate for

SECRET_CERT_CSR="/C=US/ST=NY/L=NYC/O=CloudBeaver /OU=IT Department/CN=<your-domain>"

cd /etc/nginx/

mkdir ssl

cd ssl

sudo openssl req -x509 -sha256 -nodes -days 36500 -subj "$SECRET_CERT_CSR" -newkey rsa:2048 -keyout privkey.pem -out fullchain.pem

We use CSS Modules for styling components.

import { useState } from 'react';

import { useS, s } from '@cloudbeaver/core-blocks';

import style from './ExampleComponent.m.css';



function ExampleComponent({ className }) {

  const [mode, setMode] = useState('enabled');

  const [status, setStatus] = useState(false);

  const styles = useS(style);



  function handleClick() {

    setStatus(!status);

    if(status) {

      setMode('enabled');

    } else {

      setMode('disabled');

    }

  }



  return (

    <div className={s(styles, { box: true }, className)}>

      <h2 className={s(styles, { header: true })}>This is Header</h2>

      <p className={s(styles, { message: true, status })}>This is message</p>

      <button

        className={s(styles, { switch: true })}

        data-s-mode={mode}

        type="button"

        onClick={handleClick}

      >

        Change status

      </button>

    <div>

  );

}

.box {

  border-radius: 3px;

  border: solid 1px;

}

.header {

  margin: 0;

}

.message {

  padding: 8px;

}

.status {

  color: red;

}

.switch {

  padding: 2px; 4px;

}

.switch[data-s-mode="disabled"] {

  opacity: 0.75;

}

By default CloudBeaver keeps all data on disk in the workspace.

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

It makes sense to backup this directly from time to time and also before product version upgrade.

To archive entire workspace run

tar czvf backup.tgz /var/cloudbeaver/workspace

or

tar czvf backup.tgz /var/cloudbeaver-ee/workspace

then move

Note: if your server has high load it makes sense to stop it before making a backup. Just run

By default CloudBeaver listens to plain http protocol, processes all static content via the Jetty server and is not load balanced.
All these issues can be resolved by putting a real web server in front of CloudBeaver.
We can use Nginx as the most popular web server.

sudo apt update

sudo apt install nginx

Open the Nginx configuration in your favorite text editor.
The default Nginx config file is

  location / {

    proxy_pass       http://localhost:8978;

    proxy_set_header X-Real-IP $remote_addr;

    proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;

    proxy_set_header Host $http_host;

    proxy_http_version 1.1;

    proxy_set_header Upgrade $http_upgrade;

    proxy_set_header Connection "upgrade";

  }

To identify the information (real IP address) of client connected to the web server through NGINX, add the parameter

CLoudBeaver ensures all users receive technical support for the duration of their paid license. Tickets for technical support can be submitted via the website.

Please be aware that technical support ends alongside the expiration of the license period. This occurs even though CLoudBeaver remains usable for users with a Perpetual license type.

CloudBeaver, as an open-source project, welcomes contributions from the community. If you’re interested in adding or improving localization, you have the opportunity to enhance accessibility and usability for users worldwide. Here are the steps to help you contribute your own localizations to the CloudBeaver interface.

1. Fork the CloudBeaver repository on GitHub.
2. Clone your fork to your local system.
3. Create a new branch specifically for your localization changes, for example,
   italian-localization
   .

CloudBeaver allows you to add support for new languages by registering additional localization files. Follow the steps below to add new language:

1. Navigate to the desired package where you want to add the new language. Localization files are typically located in the

   locales
   folder under
   [package-name]/src/locales
   .

   Duplicate the existing

   en.ts
   file and rename it to
   [locale-code].ts
   (e.g.,
   it.ts
   for Italian).

2. Open the newly created file and translate the tokens to the desired language. Each token is structured as

   ['token-name', 'token-value']
   . Modify the
   'token-value'
   to reflect your translation.

3. To register the new language in CloudBeaver, find the

   LocalizationService.ts
   (or similarly named service) in the same package.

   Add a switch case for the

   [locale-code]
   following the format of the existing languages.

4. Commit your changes to your branch and push them back to your repository.

To update existing translations, follow these steps:

1. Navigate to the package where the localization needs modification. Translatable resources are stored in the

   locales
   folder under
   [package-name]/src/locales/[locale-code].ts
   .

2. Open the localization file for your target language.

3. Each token is structured as

   ['token-name', 'token-value']
   . Locate the token you want to modify and update the
   'token-value'
   with the correct translation.

4. Commit your changes to your branch and push them back to your repository.

Tip: You can utilize the GitHub web interface to find the correct localization files by using the Go to file feature and searching for

en.

to display all relevant localization files.

• When you include words with apostrophes, such as

  can't
  , ensure the value is wrapped in double quotes, not single quotes, within the localization files. This avoids syntax issues in the code.
  • Correct:
    ["ui_error_message", "Can't connect to the server"]
  • Incorrect:
    ['ui_error_message', 'Can't connect to the server']

After pushing your changes to your fork, navigate back to your GitHub repository. Click on Compare & pull request to initiate the process.

Note: Make sure to select the original (parent) repository’s

devel

branch as the base branch, and your fork’s branch where you made changes as the compare branch. Follow the prompts to create a pull request to merge your changes from your fork into the parent repository.

• Once you submit your pull request, it needs to go through a review process. At least two approvals are required before merging. During this stage, you may receive requests for revisions based on feedback from our developers.
• After approval, the ticket moves to the QA (Quality Assurance) team. The QA team checks the localization in the product environment to ensure that the text fits within the UI elements and does not break the user interface.
• If all checks are passed, your changes will be merged into the CloudBeaver repository.