Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Documentation] Where I can find the specification of data-sources.json #2780

Open
ewh0 opened this issue Jul 16, 2024 · 1 comment
Open
Assignees
Labels
documentation Improvements or additions to documentation question Further information is requested xf:administration xf:connection

Comments

@ewh0
Copy link

ewh0 commented Jul 16, 2024

As a new user to cloudbeaver (and dbeaver in general), I need to pre-configure the database connection and personally I find it's difficult to look up the specification of data-sources.json

I've navigated back and force between a lot of links, such as

but none of these links fully cover the exact semantics of data-sources.json. For example, what will happen exactly if I turn save-password to true or false?

I'm looking for a specification where it lists every parameter we can put on this json file, and overall schema and the semantic of each parameter.

Using docker as example, the specification of docker compose (https://docs.docker.com/compose/compose-file/build/) basically list and explains each and every possible parameter.

IMHO, having such a document as a reference will help people quickly onboard cloudbeaver (prehaps also dbeaver) in general.

Thanks

@ewh0 ewh0 added question Further information is requested wait for review labels Jul 16, 2024
@LonwoLonwo
Copy link
Member

Hello @ewh0

Thanks for the report. We will look at it and try to reconfigure our documentation. We can probably update this article https://dbeaver.com/docs/dbeaver/Admin-Manage-Connections/

@LonwoLonwo LonwoLonwo added documentation Improvements or additions to documentation xf:connection xf:administration and removed wait for review labels Jul 16, 2024
@daelynum daelynum self-assigned this Jul 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation question Further information is requested xf:administration xf:connection
Projects
None yet
Development

No branches or pull requests

3 participants