How to configure dockerized cloudbeaver #592

Closed
opened 2026-03-04 10:30:02 -05:00 by deekerman · 7 comments
Owner

Originally created by @AOne-T on GitHub (Oct 3, 2023).

Please, describe your question in details.
I'm running Cloudbeaver using docker-compose

  cloudbeaver:
    image: dbeaver/cloudbeaver:23.2.1
    container_name: cloudbeaver
    restart: always
    ports:
      - 8978:8978
    networks:
      - mynet
    volumes:
      - dbeaver-data:/opt/cloudbeaver/workspace

In docs (https://github.com/dbeaver/cloudbeaver/wiki/Server-configuration) I found that I can change parameter sqlTextPreviewMaxLength in cloudbeaver.conf. Should I make a copy of it from a container, attach it as a volume? Or is there another way?

Originally created by @AOne-T on GitHub (Oct 3, 2023). Please, describe your question in details. I'm running Cloudbeaver using docker-compose ``` cloudbeaver: image: dbeaver/cloudbeaver:23.2.1 container_name: cloudbeaver restart: always ports: - 8978:8978 networks: - mynet volumes: - dbeaver-data:/opt/cloudbeaver/workspace ``` In docs (https://github.com/dbeaver/cloudbeaver/wiki/Server-configuration) I found that I can change parameter `sqlTextPreviewMaxLength` in cloudbeaver.conf. Should I make a copy of it from a container, attach it as a volume? Or is there another way?
deekerman 2026-03-04 10:30:02 -05:00
Author
Owner

@EvgeniaBzzz commented on GitHub (Oct 4, 2023):

Hi, @AOne-T
If you would like to change default config for all future deployments, then you should copy-paste it and map config folder (you also should copy other config files).
If you would like to change existing deploy - just change this parameter in .cloudbeaver.runtime.conf.

@EvgeniaBzzz commented on GitHub (Oct 4, 2023): Hi, @AOne-T If you would like to change default config for all future deployments, then you should copy-paste it and map config folder (you also should copy other config files). If you would like to change existing deploy - just change this parameter in .cloudbeaver.runtime.conf.
Author
Owner

@bkuhl commented on GitHub (Oct 5, 2023):

It would be awesome to see environment variable configuration capabilities baked into the container, generating the config file on startup.

@bkuhl commented on GitHub (Oct 5, 2023): It would be awesome to see environment variable configuration capabilities baked into the container, generating the config file on startup.
Author
Owner

@AOne-T commented on GitHub (Oct 6, 2023):

I located cloudbeaver.conf in docker volume (/var/lib/docler/volumes/...). Changed the parameter and restarted container. It helped, but I don't think it is the best way

@AOne-T commented on GitHub (Oct 6, 2023): I located cloudbeaver.conf in docker volume (`/var/lib/docler/volumes/...`). Changed the parameter and restarted container. It helped, but I don't think it is the best way
Author
Owner

@bkuhl commented on GitHub (Oct 6, 2023):

That will work locally for a single project. I'm working with a more advanced setup where we use a .env to configure various aspects of the environment depending on where it's being run. Being able to control connection information such as host names, usernames, passwords via environment variables is pretty critical the portability of the application. Any kind of static file won't work.

@bkuhl commented on GitHub (Oct 6, 2023): That will work locally for a single project. I'm working with a more advanced setup where we use a .env to configure various aspects of the environment depending on where it's being run. Being able to control connection information such as host names, usernames, passwords via environment variables is pretty critical the portability of the application. Any kind of static file won't work.
Author
Owner

@EvgeniaBzzz commented on GitHub (Oct 9, 2023):

Hi guys @AOne-T @bkuhl
We will implement this in future releases.
Thanks for a feature request!

@EvgeniaBzzz commented on GitHub (Oct 9, 2023): Hi guys @AOne-T @bkuhl We will implement this in future releases. Thanks for a feature request!
Author
Owner

@chardskarth commented on GitHub (Jan 19, 2024):

I successfully configured dbeaver to work behind an nginx. Had to tweak /opt/cloudbeaver/conf/cloudbeaver.conf's
server.rootURI from / to /dbeaver

Then in my nginx, I had to simply add this:

server {
  listen 80;
  server_name ${GENERIC_HOSTNAME};

  location /dbeaver {
    proxy_pass http://${DBEAVER_DOCKER_HOSTNAME}:${DBEAVER_DOCKER_PORT};
  }
}

Now i'm able to access http://localhost:3000/dbeaver (nginx)

But It was a bit tedious to configure.

  1. Had to copy /opt/cloudbeaver/conf/cloudbeaver.conf, tweak, and then add back as a volume
  2. I had to hard code the value. Specifying environment variable in the .conf file doesn't seem to work. I initially had this challenge with the nginx' docker, good thing an recent release allowed this feature! (adding in /etc/nginx/templates 🤘. See here)

An easier way to configure this please 🙏🙏


PS: Related -> #366

@chardskarth commented on GitHub (Jan 19, 2024): I successfully configured dbeaver to work behind an nginx. Had to tweak `/opt/cloudbeaver/conf/cloudbeaver.conf`'s `server.rootURI` from `/` to `/dbeaver` Then in my nginx, I had to simply add this: ``` server { listen 80; server_name ${GENERIC_HOSTNAME}; location /dbeaver { proxy_pass http://${DBEAVER_DOCKER_HOSTNAME}:${DBEAVER_DOCKER_PORT}; } } ``` Now i'm able to access `http://localhost:3000/dbeaver` (nginx) But It was a bit tedious to configure. 1. Had to copy `/opt/cloudbeaver/conf/cloudbeaver.conf`, tweak, and then add back as a volume 2. I had to hard code the value. Specifying environment variable in the .conf file doesn't seem to work. I initially had this challenge with the nginx' docker, good thing an recent release allowed this feature! (adding in /etc/nginx/templates 🤘. See [here](https://hub.docker.com/_/nginx)) An easier way to configure this please 🙏🙏 --- PS: Related -> #366
Author
Owner

@EvgeniaBzzz commented on GitHub (Sep 23, 2024):

Environment variables were added in v.24.2.1
Server configuration will be updated soon.

Here are new variables with default values:

CLOUDBEAVER_SERVICE_PORT:8978
CLOUDBEAVER_WORKSPACE_LOCATION:workspace
CLOUDBEAVER_EXPIRE_SESSION_AFTER_PERIOD:1800000
CLOUDBEAVER_DEVEL_MODE:true
CLOUDBEAVER_APP_ANONYMOUS_ACCESS_ENABLED:true
CLOUDBEAVER_APP_DEFAULT_USER_TEAM:user
CLOUDBEAVER_APP_RESOURCE_MANAGER_ENABLED:true
CLOUDBEAVER_RESOURCE_QUOTA_DATA_EXPORT_FILE_SIZE_LIMIT:10000000
CLOUDBEAVER_RESOURCE_QUOTA_RESOURCE_MANAGER_FILE_SIZE_LIMIT:500000
CLOUDBEAVER_RESOURCE_QUOTA_SQL_MAX_RUNNING_QUERIES:100
CLOUDBEAVER_RESOURCE_QUOTA_SQL_RESULT_SET_ROWS_LIMIT:100000
CLOUDBEAVER_RESOURCE_QUOTA_SQL_TEXT_PREVIEW_MAX_LENGTH:4096
CLOUDBEAVER_RESOURCE_QUOTA_SQL_BINARY_PREVIEW_MAX_LENGTH:261120
CLOUDBEAVER_APP_SUPPORTS_CUSTOM_CONNECTIONS:false
CLOUDBEAVER_APP_READ_ONLY_CONNECTION_INFO:false

If anything is missing, please leave a comment here or create a new issue.
Thank you for being with CloudBeaver! 🦫

@EvgeniaBzzz commented on GitHub (Sep 23, 2024): Environment variables were added in v.24.2.1 [Server configuration](https://github.com/dbeaver/cloudbeaver/wiki/Server-configuration) will be updated soon. Here are new variables with default values: > CLOUDBEAVER_SERVICE_PORT:8978 > CLOUDBEAVER_WORKSPACE_LOCATION:workspace > CLOUDBEAVER_EXPIRE_SESSION_AFTER_PERIOD:1800000 > CLOUDBEAVER_DEVEL_MODE:true > CLOUDBEAVER_APP_ANONYMOUS_ACCESS_ENABLED:true > CLOUDBEAVER_APP_DEFAULT_USER_TEAM:user > CLOUDBEAVER_APP_RESOURCE_MANAGER_ENABLED:true > CLOUDBEAVER_RESOURCE_QUOTA_DATA_EXPORT_FILE_SIZE_LIMIT:10000000 > CLOUDBEAVER_RESOURCE_QUOTA_RESOURCE_MANAGER_FILE_SIZE_LIMIT:500000 > CLOUDBEAVER_RESOURCE_QUOTA_SQL_MAX_RUNNING_QUERIES:100 > CLOUDBEAVER_RESOURCE_QUOTA_SQL_RESULT_SET_ROWS_LIMIT:100000 > CLOUDBEAVER_RESOURCE_QUOTA_SQL_TEXT_PREVIEW_MAX_LENGTH:4096 > CLOUDBEAVER_RESOURCE_QUOTA_SQL_BINARY_PREVIEW_MAX_LENGTH:261120 > CLOUDBEAVER_APP_SUPPORTS_CUSTOM_CONNECTIONS:false > CLOUDBEAVER_APP_READ_ONLY_CONNECTION_INFO:false If anything is missing, please leave a comment here or create a new issue. Thank you for being with CloudBeaver! 🦫
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Dependencies

No dependencies set.

Reference
starred/cloudbeaver#592
No description provided.