Skip to content

Managing CloudBeaver server on AWS

dbeaver-devops edited this page Nov 22, 2024 · 2 revisions

Table of contents

Overview

This guide explains the initial launch, management, and maintenance of CloudBeaver on AWS, including server configuration, updates, and backups.

Launch your AWS instance

After launching your AWS instance, follow these steps to access CloudBeaver:

  1. In your browser, go to http://<Instance_IP>/, where <Instance_IP> is the public IP address of your AWS instance.

  2. 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 Finding the Public IP Address of Your Instance in the AWS documentation.

For detailed configuration steps, see CloudBeaver Administration guide.

Managing CloudBeaver with the server manager utility

CloudBeaver provides a built-in server manager utility in AWS deployments for starting, stopping, updating, configuring, and backing up the server.

Using the server manager

To list available commands and options, enter:

cloudbeaver help

Managing server state

To start or stop the CloudBeaver server, use:

  • Start the server:

    cloudbeaver start
  • Stop the server:

    cloudbeaver stop

Version update procedure

To update CloudBeaver, follow these steps:

  1. Connect to your AWS instance via SSH.
  2. Check available versions:
    cloudbeaver update list
  3. Run the update command:
    cloudbeaver update 24.2.0

Note: Replace 24.2.0 with the desired version number.

Backup and restore procedure

Create backups for service volumes, database dumps, and internal certificates:

  • Create a backup:

    cloudbeaver createBackup

    Options include:

    • --include-certs: Include certificates in the backup.
    • --skip-db-service: Skip database dump for external databases.
  • Restore from backup:

    cloudbeaver restoreBackup

Server configuration

To configure the CloudBeaver server, update the .env file:

cloudbeaver configure

CloudBeaver Documentation

User Guide

Installation

Configuration

CloudBeaver AWS

CloudBeaver Enterprise Edition

Deployment

Clone this wiki locally