Command line parameters

Table of contents

• Modify the run script
• Pass parameters using environment variables
  • Manual start
  • Docker
• System parameters
  • VM parameters

There are two ways to pass command line parameters to the CloudBeaver server.

Modify the run script

Modify the run-cloudbeaver-server.sh script and add extra parameters after the java command in the last line.

For example, add a memory limit and UI language parameter:

java -Xmx2048M -jar ${launcherJar} \
  -product io.cloudbeaver.product.ce.product \
  -web-config conf/cloudbeaver.conf \
  -nl en -registryMultiLanguage

Then restart the server:

./run-cloudbeaver-server.sh

Note: To modify the script, you must build CloudBeaver from sources.

Pass parameters using environment variables

You can set the JAVA_OPTS environment variable with JVM parameters. This works for both manual startup and Docker containers.

Manual start

export JAVA_OPTS=-Xmx1000m
./run-cloudbeaver-server.sh

Docker

Pass JAVA_OPTS to the container using the -e option:

docker run -d --name cloudbeaver-ee -p 8978:8978 \
  -e JAVA_OPTS="-Xmx2048M" \
  -v /var/cloudbeaver-ee/workspace:/opt/cloudbeaver/workspace \
  dbeaver/cloudbeaver-ee:latest

Note: only JVM parameters can be passed with JAVA_OPTS.

System parameters

Name	Value	Example
-nl	UI language and locale (affects UI translation, number/date formats). For supported values, see Supported languages.	-nl "en"
-data	Workspace path.	-data "/opt/cloudbeaver/"
-clean	Clears all Eclipse caches. Use it if CloudBeaver fails to start after it upgrades.
-vmargs	Passes VM parameters.	See VM arguments table

Important: The -data parameter only affects the workspace location. Other folders are created in the default location.

VM parameters

You can pass any advanced Java parameters supported by your local JVM. Parameters supported by HotSpot JVM (21): https://docs.oracle.com/en/java/javase/21/docs/specs/man/java.html

Parameters supported by all JVMs:

Name	Value	Example
-Xms	Sets initial memory available for CloudBeaver.	-Xmx1000m
-Xmx	Sets maximum memory available for CloudBeaver.	-Xmx4000m