Documentation

Server configuration

There are several configuration files in CloudBeaver.

Main server configuration

Primary configuration file is cloudbeaver.conf. By default it is placed in folder /etc/cloudbeaver/.
But in most cases it is redefined for each server by command line parameter -web-config <config-file-path>.
Server configuration is in JSONC format (JSON with comments and without redundant quotes). It can be parsed by the most of JSON parsers in lenient mode.

Typical configuration:

{
    server: {
        serverPort: 8978,
        serverName: "CloudBeaver Sample Server",

        // Paths are absolute or relative to the server root folder
        workspaceLocation: "workspace",
        contentRoot: "web",
        driversLocation: "drivers",

        rootURI: "/",
        serviceURI: "/dbeaver/",

        // Webapp configuration file
        productConfiguration: "conf/product.conf",

        expireSessionAfterPeriod: 600000,

        develMode: false
    },
    app: {
        anonymousAccessAllowed: true,
        anonymousUserRole: "user"
    }

}

All paths can be absolute or are relative to the server start directory (or current directory).
Parameters:

NameDescription
serverPort Port for CloudBeaver web server
workspaceLocation Root folder for projects
contentRoot Path to directory with static content
driversLocation Optional path for driver jar files
productConfiguration Path to product (web interface) configuration file (json)
develMode When set to true extra debug information is printed in logs and GraphQL console is enabled on server.
anonymousAccessEnabled Allows anonymous access. Anonymous users work with role 'User'.
authenticationEnabled Enables users authentication. If disabled then only anonymous access is allowed.
supportsCustomConnections Allows users to create custom connections to any databases. Otherwise only CB administrator can create/edit connections.

Datasources configuration

You can find detailed description here