Version

    16. Example Configuration File

    Below is an example configuration file including the most commonly used configuration properties. You can use this configuration file as a template and uncomment and modify the desired properties. See Properties Details below for more information on the properties used in this file. For a full list of all configuration properties, see List of Configuration Properties. For cluster-specific properties, see Mandatory Cluster Properties and Optional Cluster Properties.

    Changes in the configuration file will take effect after CloverDX Server is restarted.

    ##The following properties are primarily used in the sandboxes root path specification.
    #sandboxes.home=${clover.home}/sandboxes
    #sandboxes.home.local=${clover.home}/sandboxes-local
    #sandboxes.home.partitioned=${clover.home}/sandboxes-partitioned
    
    ##CloverDX libraries home
    #libraries.home=${sandboxes.home}/libraries
    
    ##CloverDX Wrangler workspaces home
    #workspaces.home=${sandboxes.home}
    
    ## Uncomment and modify the properties below to change the default user lockout values.
    
    ## Number of failed login attempts after which a next failed login attempt will lock the user.
    ## 0 means feature is switched off
    ## Default value is 5
    #security.lockout.login.attempts=5
    
    ## Period of time during which the failed login attempts are counted.
    ## Default value is 300s (5 min)
    #security.lockout.reset.period=300
    
    ## Period of time after which a successful login attempt will unlock a previously locked user.
    ## Default value is 300s (5 min)
    #security.lockout.unlock.period=300
    
    ## Comma separated list of emails which will be notified when a user is locked out.
    #security.lockout.notification.email=
    
    ## Uncomment lines bellow to enable the cluster mode.
    #cluster.enabled=true
    #cluster.node.id=node01
    #cluster.jgroups.bind_address=localhost
    #cluster.jgroups.start_port=7800
    #cluster.http.url=http://localhost:8083/clover
    #cluster.group.name=cloverCluster
    
    ## Instance indicator
    ## Modify the color and label of your environment. Colors can be: green, blue, yellow, or red.
    #webGui.instance.color=blue
    #webGui.instance.label=DEV
    
    ## Uncomment and tweak one of the following sections to use a
    ## separate database instead of the embedded Derby. This is
    ## recommended practice for production deployments.
    
    ## Example configuration for MySQL database.
    ## Modify the url, username and password for your environment.
    #jdbc.driverClassName=com.mysql.cj.jdbc.Driver
    #jdbc.url=jdbc:mysql://hostname:3306/clover?useUnicode=true&characterEncoding=utf8
    #jdbc.username=user
    #jdbc.password=pass
    #jdbc.dialect=org.hibernate.dialect.MySQLDialect
    
    ## Example configuration for DB2 database.
    ## Modify the url, username and password for your environment.
    #jdbc.driverClassName=com.ibm.db2.jcc.DB2Driver
    #jdbc.url= jdbc:db2://hostname:50000/clover
    #jdbc.username=user
    #jdbc.password=pass
    #jdbc.dialect=org.hibernate.dialect.DB2Dialect
    
    ## Example configuration for Oracle database.
    ## Modify the url, username and password for your environment.
    #jdbc.driverClassName=oracle.jdbc.OracleDriver
    #jdbc.url=jdbc:oracle:thin:@hostname:1521:db
    #jdbc.username=user
    #jdbc.password=pass
    #jdbc.dialect=org.hibernate.dialect.Oracle12cDialect
    
    ## Example configuration for MSSQL database.
    ## Modify the url, username and password for your environment.
    #jdbc.driverClassName=com.microsoft.sqlserver.jdbc.SQLServerDriver
    #jdbc.url=jdbc:sqlserver://hostname:1433;databaseName=clover
    #jdbc.username=user
    #jdbc.password=pass
    #jdbc.dialect=org.hibernate.dialect.SQLServerDialect
    
    ## Example configuration for PostgreSQL database.
    ## Modify the url, username and password for your environment.
    #jdbc.driverClassName=org.postgresql.Driver
    #jdbc.url=jdbc:postgresql://hostname/clover?charSet=UTF-8
    #jdbc.username=user
    #jdbc.password=pass
    #jdbc.dialect=org.hibernate.dialect.PostgreSQLDialect

    Properties Details

    Property Description

    sandboxes.home

    Directory where sandbox contents are stored.

    sandboxes.home.local

    Used in cluster environments only; path to a local sandbox which is to be accessible only to a certain cluster node.

    sandboxes.home.partitioned

    Used in cluster environments only; path to a partitioned sandbox directory.

    libraries.home

    Directory for installed CloverDX libraries.

    workspaces.home

    Directory for Wrangler workspaces.

    security.lockout.login.attempts

    Number of login attempts until a user is locked. See User Lockout for more information.

    security.lockout.reset.period

    Period during which login attempts are counted. See User Lockout for more information.

    security.lockout.unlock.period

    Period after which a successful login releases the lock. See User Lockout for more information.

    security.lockout.notification.email

    Comma separated list of emails which will be notified when a user is locked out.

    cluster.enabled

    cluster.node.id

    cluster.jgroups.bind_address

    cluster.jgroups.start_port

    cluster.http.url

    cluster.group.name

    Mandatory properties to enable clustering. See Cluster Mandatory properties for more information.

    webGui.instance.color

    Changes the color of the instance indicator in the left upper corner in CloverDX console. See server instance indicator for more information.

    webGui.instance.label

    Changes the label of the instance indicator in the left upper corner in CloverDX console. See server instance indicator for more information.

    system database connection examples

    For more information on system database installation and configuration, see system database configuration. When setting up a connection to a system database, remember to place the appropriate JDBC driver in the application server classpath (e.g., for Tomcat: <TOMCAT_INSTALL_DIR>/LIB).