Configuring server datasources

Table of contents

• Datasources configuration file
  • Pre-configuring credentials
• Managing access to connections

As an administrator, you can pre-configure database connections for your CloudBeaver server. Users just pick a connection from the toolbar and enter their credentials - no other setup needed on their side.

Datasources configuration file

Connections are defined in data-sources.json. For the full file structure and field reference, see data-sources.json reference.

Pre-configuring credentials

If you deploy the server repeatedly, you can include credentials directly in data-sources.json instead of setting them up in the UI each time.

Warning: Credentials in data-sources.json are stored in plain text until the first connection. Make sure no unauthorized users have access to the server config files during this time.

To pre-configure credentials:

1. Add auth-properties with your credentials to data-sources.json. The fields depend on the auth model - see auth model reference.
2. Start the server.
3. Open the connection in the UI for the first time.
4. CloudBeaver encrypts the credentials, removes them from data-sources.json, and users can connect from now on without entering credentials.

Managing access to connections

You can control which users and teams have access to each pre-configured connection. For details, see Pre-configured permissions for connections.