Prerequisites and Software Dependencies

Overview

Documents the prerequisites and third party software dependencies used for the reference deployment.

Prerequisites

Sample RF2 or ClaML data is needed to load and test the server.  Such data is provided in the project in the config module.  See config/src/main/resources/data for examples.  Also, There are a number of "Reset***.java" integration tests (with corresponding profiles in integration-tests) for building different "stock" builds of the database from these sample files.

Development Software Dependencies

Following are the third-party software dependencies needed to get a development environment up and running.

  • Git
  • Java 1.8
  • Maven 3.3+
    • There are no special requirements for configuring settings.xml.

Deployment Software Dependencies

Following are the third-party software dependencies needed to get a deployment environment ready.

  • MySQL 5.6 (may not work with 5.7 - project needs updated JDBC driver)
    • Optimize settings in my.ini or my.cnf (%PROGRAMDATA%/MySQL/MySQL Server 5.6 on Windows)
    • innodb_flush_log_at_trx_commit=2
      • ** For dev database, this can be set to 2, set to 1 for prod deployment
    • innodb_log_buffer_size=64M
    • innodb_buffer_pool_size=2048M
    • innodb_log_file_size=500M
    • innodb_file_per_table=1
    • innodb_thread_concurrency=0
    • join_buffer_size=32M
    • sort_buffer_size=32M
    • max_allowed_packet=100M
  • Nginx - not needed for a local development environment
  • Tomcat 8+ or Jetty 9+ (need websockets)