Skip to content

First steps

This guide helps you quickly deploy CloudBeaver. You’ll launch the server, open the app in your browser, and prepare it for database connections.

Deploy CloudBeaver

The easiest way to run CloudBeaver is with Docker Compose:

Tip

You can also deploy CloudBeaver on Kubernetes, or in the cloud. See CloudBeaver deployment for more options.

  1. Clone the deployment repo and navigate to the repository:

    git clone https://github.com/dbeaver/cloudbeaver-deploy
cd ~/cloudbeaver-deploy

  2. Copy the example file to create your .env file:

    cp .env.example .env

    Then open the file and make sure to change the default database password:

    nano .env

    Tip

    This file controls startup settings like ports, database config, and proxy type. See environment file variables and server configuration.

  3. Start the server:

    docker-compose up -d

  4. Open http://<server-ip>:8978 in your browser to launch the easy config wizard.

    1. Follow the steps in the easy config wizard.

    2. If you’re using a paid version, you’ll need to provide your license key. Learn more

    Need custom networking, HTTPS, or a proxy?

    See Proxy configuration and Domain Manager.

  5. Once setup is complete, continue with Basic operations.

Using the Community Edition?

See the CloudBeaver Community deployment instructions in the GitHub wiki.

Create a new connection

  1. Click the + button in the top menu and select New Connection.
  2. Choose a driver.

  3. Fill in connection details.

    Info

    See configuring connection settings for help.

  4. Click Test to check the connection (optional).

  5. Click Create.

Resources for database operations

Additional resources