CloudBeaver Community deployment from docker image

Table of contents

• Overview
• Deploying steps
• Update Docker image
• Offline deployment
• Additional configuration for HTTPS

Overview

CloudBeaver Community is available for deployment via a Docker image.

Deploying steps

Follow these steps to deploy CloudBeaver using Docker:

For additional configuration details, refer to the Docker documentation.

1. Pull the latest CloudBeaver image from DockerHub:

   docker pull dbeaver/cloudbeaver:latest

   For a specific version, replace latest with the desired version tag. For more details on version tags, see Docker tags.

2. Run the Docker container:

   docker run --name cloudbeaver --rm -ti -p 8978:8978 -v /var/cloudbeaver/workspace:/opt/cloudbeaver/workspace dbeaver/cloudbeaver:latest

   • Replace the first port argument 8978 with the port you want to use on the host machine.
   • Ensure the directory /var/cloudbeaver/workspace exists and is writable for data persistence.
   • (Optional) If you're using a proxy, you can set the IP address manually:

   docker run --name cloudbeaver --rm -ti -p 127.0.0.1:8978:8978 -v /var/cloudbeaver/workspace:/opt/cloudbeaver/workspace dbeaver/cloudbeaver:latest

   To keep the container running in the background (daemon mode), add:

    --restart unless-stopped

3. Access the application:

   http://<server-ip>:8978
   

4. Access <server-ip> databases

   To access a database running on the host machine from the container (Linux only), use:

   --network host

   Alternatively, pass the host IP address:

   --add-host=host.docker.internal:<your_host_ip>

Update Docker image

Warning: Always backup your workspace before updating. Downgrades are not supported.

To update using a standalone Docker image:

1. Stop and remove the existing container:

   docker stop cloudbeaver
   docker rm cloudbeaver

2. Pull the new image:

   docker pull dbeaver/cloudbeaver:latest

3. Run the updated container:

   docker run --name cloudbeaver -d --restart unless-stopped -p 8978:8978 -v /var/cloudbeaver/workspace:/opt/cloudbeaver/workspace dbeaver/cloudbeaver:latest

Offline deployment

If deploying on a server without internet access:

1. Archive the Docker image on a machine with internet:

   docker save dbeaver/cloudbeaver | gzip > cloudbeaver.tar.gz

2. Transfer the archive to the target server.
3. Load the image:

   docker load < cloudbeaver.tar.gz

4. Run the container as described above.

Additional configuration for HTTPS

CloudBeaver uses the Jetty server for web application hosting. If you need to configure HTTPS for secure communication, refer to the Jetty configuration guide for detailed instructions.