CloudBeaver Enterprise is a client-server application. It requires server deployment. You can deploy it on a single host (e.g. your local computer) or in a cloud.
It is the simplest way to install CloudBeaver Enterprise Edition.
All you need is a Linux, macOS, or Windows machine with Docker.
CloudBeaver can be run in a single docker container.
However you can use Docker compose for easy web server (HTTPS) configuration.
- Minimum 4GB RAM
- Minimum 50GB storage, > 100GB recommended
- Ubuntu recommended
- Docker installed. Make sure you have chosen the right OS distro.
- docker-compose binary installed and added to your PATH variable. Supported versions 2.10 and above
- If you install
docker-compose-plugin, you must use thedocker composecommand instead ofdocker-compose.
- If you install
Starting from CloudBeaver v25.0 process inside the container now runs as the ‘dbeaver’ user (‘UID=8978’), instead of ‘root’.
If a user with ‘UID=8978’ already exists in your environment, permission conflicts may occur.
Additionally, the default Docker volumes directory’s ownership has changed.
Previously, the volumes were owned by the ‘root’ user, but now they are owned by the ‘dbeaver’ user (‘UID=8978’).
Starting from v25.1, CloudBeaver supports two types of proxy servers: Nginx and HAProxy. You can choose your preferred proxy type by setting the following variable in the .env file:
PROXY_TYPE=nginx # Available options: nginx, haproxy
The default value is nginx. Switching between proxy types is seamless: configuration files and SSL certificates are retained due to shared Docker volumes.
However, note that the container name has changed from nginx to web-proxy.
When using Docker Compose with host networking mode (network_mode: host), you may configure proxy ports using these environment variables:
LISTEN_PORT_HTTP=80
LISTEN_PORT_HTTPS=443
These variables specify which ports the proxy listens to inside the container.
If you use Nginx as your proxy server and customize the COMPOSE_PROJECT_NAME in your .env file, make sure to pass this variable explicitly to the container environment:
environment:
- COMPOSE_PROJECT_NAME=${COMPOSE_PROJECT_NAME}
This step is only required for Nginx, as HAProxy resolves service names via Docker DNS automatically.
- Clone repository
git clone https://github.com/dbeaver/cloudbeaver-deploy
- Open the configuration file
- Navigate to
cloudbeaver-deploy - Copy
.env.exampleto.env - Edit the
.envfile to set configuration properties - It is highly recommended to change the default database password in
CLOUDBEAVER_DB_PASSWORDvariable
- Navigate to
- Start the cluster
docker-compose up -dordocker compose up -d
- Ensure the following TCP ports are available in your network stack
- 80/tcp
- 443/tcp (for HTTPS access)
- Open
https://<deployment-machine-ip-address>to access the app. This URL will open the admin panel when the app is first started.
docker-compose down
There are two ways to configure SSL:
- You can configure HTTPS automatically in the admin panel.
In this case your server domain address will be<deployment-domain>.<organization-domain>.databases.team.
You can setup organization and deployment domains. - You can issue you own SSL cenrtificate and configure it manually by editing nginx config.
as user root run following commands before Configuring and starting the CloudBeaver cluster:
loginctl enable-linger 1000echo 'net.ipv4.ip_unprivileged_port_start=80' >> /etc/sysctl.confsysctl -p
on step 4 of Configuring and starting the CloudBeaver cluster use podman-compose tool intead of docker-compose and on step 4 define compose file name:
podman-compose -f podman-compose.yml up -d
or replace docker-compose.yml with podman-compose.yml and use podman-compose without compose project definition
- Replace the value of
CLOUDBEAVER_VERSION_TAGin.envwith a preferred version. If you use the taglatest, you don't need to do anything during this step. - Pull new docker images:
docker-compose pullordocker compose pull - Restart the cluster:
docker-compose up -dordocker compose up -d
