7. Installing

    This chapter describes two different Server installations - Evaluation Server and Production Server - and provide instructions on installing the CloverDX Server License.

    Evaluation Server

    The Evaluation Server consists of CloverDX Server bundled with the Tomcat application container. The Server performs basic configuration during the first startup and requires no additional database server. This option is recommended only for basic evaluation of CloverDX Server's functions.

    However with further configuration, it is possible to evaluate other CloverDX Server features and even make the Evaluation Server ready for production environment. This process requires a connection to an external, dedicated database and subsequent configuration of services (e.g. SMTP, LDAP, etc.).

    The Apache Derby DB, bundled with the Evaluation Server, is not supported for production environment. It is supported for evaluation purposes with Tomcat 9 application container only. Please use one of the supported database systems.

    Production Server

    In the case of Production Server, the CloverDX Server is installed on one of the several compatible application containers. This process requires additional configuration (e.g. memory allocation, database connection, etc.) but allows you to choose an application container and external database according to your preference.

    Installation and Configuration Procedure

    To create a fully working instance of Production CloverDX Server, you should:

    • Install an application server

      CloverDX Server is compatible with several application containers. Following subsections offer detailed instructions on installation of the respective application servers and their subsequent configuration.

    • Set up limits on a number of opened files, memory allocation and firewall exceptions

      CloverDX Server's graph transformations and evaluations may require more memory than the default limit set in the database as well as higher number of simultaneously opened files. Moreover, some components require firewall exceptions to be set. These instructions provide recommendation on adjusting both the Memory Settings and the Maximum Number of Open Files, as well as Firewall Exceptions.

    • Install CloverDX Server into the application server

      CloverDX Server is provided as a web archive (.war) file for an easy deployment.

    • Create a database dedicated to CloverDX Server

      Unlike the Evaluation Server, the Production Server requires that you have created a dedicated database for CloverDX Server. In the configuration phase of this manual, you will be guided to System Database Configuration with instructions on how to properly configure the properties file of various databases.

    • Set up a connection to the database

      You can set up the connection to the database via Server’s GUI in Configuration  Setup  Database. Alternatively, you can set up the connection in the properties file before starting CloverDX Server.

    • Install a license

      To be able to execute graphs, you need to install a valid license, see Activation.

    • Perform additional Server configuration

      • Set up a master password for secure parameters

        When handling sensitive information (e.g. passwords), it is advised to define secure graph parameters. This action requires a master password (see Secure Parameters).

      • Set up SMTP server connection

        CloverDX Server lets you configure an SMTP connection for reporting events on the Server via emails.

      • Configure temp space

        CloverDX Server works with temporary directories and files. To ensure components work correctly, you should configure the Temp space location on the file system. For details, see Temp Space Management.

      • Configure sandboxes

        Lastly, you should set the content security and user’s permissions for sandboxes. For details and instructions, see Sandboxes.