Installing IDA Application on Java 17(Recommended)

Starting from version 25.0.3, IDA supports Spring Framework v6 based on Java 17, which is the recommended way to install the IDA application. Below are the installation steps.

The IDA Web Application can be installed on Liberty, Docker, or Openshift. Please access IDA web URLs using HTTPS.

Installing on Liberty

Prerequisites

Java 17 is installed on server.
Download Liberty installation package: Open Liberty v24.0.0.3+, WebSphere Liberty v24.0.0.3+.

1. Create a Liberty server

You can create a server from the command line.

Unzip the Liberty installation package. Open a command line, then navigate to the wlp/bin directory. Where is the location you installed Liberty on your operating system.
Run the following command to create a server.

<path_to_liberty>/wlp/bin/server create <SERVER_NAME>

The ‘SERVER_NAME’ must use only Unicode alphanumeric (for example, 0-9, a-z, A-Z), underscore (_), dash (-), plus (+), and period (.) characters. The name cannot begin with a dash or period. Your file system, operating system, or compressed file directory might impose more restrictions.

If the server is created successfully, you will receive the message: Server SERVER_NAME created.

2. Configure server.xml

Edit server.xml from <path_to_liberty>/wlp/usr/servers/<SERVER_NAME> folder. You could use the below sample server.xml to override your server.xml and update httpPort, httpsPort and keyStore password and enable features ssl, websocket.

IDA supports JNDI datasource. You can configure a data source and JDBC provider for database connectivity.

1. In the server.xml file, define a shared library that points to the location of your JDBC driver JAR or compressed files. For example:

  <library id="DBLib">
      <fileset dir="${shared.config.dir}/lib" includes="*.jar"/>
  </library>

2. Configure attributes for the data source, such as JDBC vendor properties and connection pooling properties. For example:

  <dataSource jndiName="jdbc/ida">
      <connectionManager maxPoolSize="50"/>
      <jdbcDriver libraryRef="DBLib" />
      <properties.postgresql serverName="localhost" portNumber="5432"
        databaseName="idadb" user="idadbadmin" password="idadbadmin" />
  </dataSource>

3. Support for X-Forwarded-* and Forwarded headers

Add the below configuration in server.xml to support X-Forwarded-* and Forwarded headers in Liberty, which means better integration with front-end HTTP load balancers and web servers.

  <httpEndpoint id="defaultHttpEndpoint"
                        host="*" httpPort="-1"
                        httpsPort="9443">
      <remoteIp useRemoteIpInAccessLog="true"/>
  </httpEndpoint>

Here is a sample server.xml

Please update the fields host, httpPort, and httpsPort, library, and dataSource. For more information about configuring relational database connectivity in Liberty, please refer to Data Source Configuration.

For example:

<?xml version="1.0" encoding="UTF-8"?>
<server description="new server">

    <!-- Enable features -->
    <featureManager>
        <feature>servlet-6.0</feature>
        <feature>transportSecurity-1.0</feature>
        <feature>websocket-2.1</feature>
        <feature>jdbc-4.2</feature>
        <feature>jndi-1.0</feature>
    </featureManager>

    <!-- This template enables security. To get the full use of all the capabilities, a keystore and user registry are required. -->

    <!-- For the keystore, default keys are generated and stored in a keystore. To provide the keystore password, generate an
         encoded password using bin/securityUtility encode and add it below in the password attribute of the keyStore element.
         Then uncomment the keyStore element. -->
    <keyStore id="defaultKeyStore" password="idaAdmin" />

    <webContainer invokeFlushAfterService="false"/>

    <!--For a user registry configuration, configure your user registry. For example, configure a basic user registry using the
        basicRegistry element. Specify your own user name below in the name attribute of the user element. For the password,
        generate an encoded password using bin/securityUtility encode and add it in the password attribute of the user element.
        Then uncomment the user element. -->
    <basicRegistry id="basic" realm="BasicRealm">
        <!-- <user name="yourUserName" password="" />  -->
    </basicRegistry>

    <httpOptions id="defaultHttpOptions" ThrowIOEForInboundConnections="false"/>

    <!-- To access this server from a remote client add a host attribute to the following element, e.g. host="*" -->
    <httpSession cookieSameSite="None"/>

    <httpEndpoint id="defaultHttpEndpoint"
                        host="*" httpPort="-1"
                        httpsPort="9443">
      <remoteIp useRemoteIpInAccessLog="true"/>
    </httpEndpoint>
    <!-- Automatically expand WAR files and EAR files -->
    <applicationManager autoExpand="true" startTimeout="360s" stopTimeout="120s"/>
	  <application type="war" id="ida" name="ida" location="${server.config.dir}/apps/ida-web.war">
      <classloader delegation="parentLast" />
    </application>

    <!-- Shared libraries
      https://www.ibm.com/support/knowledgecenter/SSEQTP_liberty/com.ibm.websphere.wlp.doc/ae/cwlp_sharedlibrary.html
    -->
    <!-- JNDI data source configuration -->

    <!-- Define a shared library pointing to the location of the JDBC driver JAR or compressed files. For example:  -->

    <!-- PostgreSQL Example-->
    <library id="PostgresSQLLib">
        <fileset dir="${shared.config.dir}/lib/global" includes="postgresql-42.2.8.jar"/>
    </library>

    <!-- Configure attributes for the data source, such as JDBC vendor properties and connection pooling properties. For example:  -->
    <dataSource jndiName="jdbc/ida">
      <connectionManager maxPoolSize="50"/>
      <jdbcDriver libraryRef="PostgresSQLLib" />
      <properties.postgresql serverName="localhost" portNumber="5432"
        databaseName="idadb" user="idadbadmin" password="idadbadmin" />
    </dataSource>
    <!-- PostgreSQL Example End-->

    <!-- DB2 Example-->
    <library id="DB2Lib">
        <fileset dir="${shared.config.dir}/lib/global" includes="db2jcc4-11.1.jar"/>
    </library>
    <dataSource jndiName="jdbc/ida" statementCacheSize="60" id="DB2DataSource"
          isolationLevel="TRANSACTION_READ_COMMITTED" type="javax.sql.DataSource" transactional="true">
      <connectionManager maxPoolSize="50"/>
      <jdbcDriver libraryRef="DB2Lib"/>
      <properties.db2.jcc databaseName="${env.DATABASE_NAME}" currentSchema="${env.DATABASE_SCHEMA}"
                serverName="${env.DATABASE_SERVER_NAME}" portNumber="${env.DATABASE_PORT_NUMBER}"
                user="${env.DATABASE_USER}" password="${env.DATABASE_PASSWORD}"/>
    </dataSource>
    <!-- DB2 Example End-->

    <!-- Oracle Example-->
    <library id="ORACLELib">
      <fileset dir="${shared.config.dir}/lib/global" includes="ojdbc8-12.2.0.1.jar"/>
    </library>
    <dataSource jndiName="jdbc/ida" statementCacheSize="60" id="OracleDataSource" isolationLevel="TRANSACTION_READ_COMMITTED" type="javax.sql.DataSource" transactional="true">
      <connectionManager maxPoolSize="50"/>
      <jdbcDriver libraryRef="ORACLELib"/>
      <properties.oracle url="${env.DATABASE_URL}"
          user="${env.DATABASE_USER}" password="${env.DATABASE_PASSWORD}"/>
    </dataSource>
    <!-- Oracle Example END-->

    <!-- MySQL Example-->
    <library id="MYSQLLib">
      <fileset dir="${shared.config.dir}/lib/global" includes="mysql-connector-java-8.0.18.jar"/>
    </library>

    <!-- Configure attributes for the data source, such as JDBC vendor properties and connection pooling properties. For example:  -->
    <dataSource jndiName="jdbc/ida" statementCacheSize="60" id="DefaultDataSource"
          isolationLevel="TRANSACTION_READ_COMMITTED" type="javax.sql.DataSource" transactional="true">
      <connectionManager maxPoolSize="50"/>
      <jdbcDriver libraryRef="MYSQLLib"/>
      <properties databaseName="<DATABASE_NAME>"
                serverName="<SERVER_NAME>" portNumber="<SERVER_PORT>"
                user="<USER_NAME>" password="<PASSWORD>"/>
    </dataSource>
    <!-- MySQL Example End-->
</server>

Liberty supports Advanced Encryption Standard (AES) encryption for passwords that are stored in the server.xml file. In the Liberty installation bin folder, you can use the securityUtility command to encrypt your password.

./securityUtility encode password

For more information about encryption, please refer to SecurityUtility Command.

If the database requires an SSL connection, set it in the datasource prop, for example, for DB2:

 <properties.db2.jcc databaseName="${env.DATABASE_NAME}" currentSchema="${env.DATABASE_SCHEMA}"
                serverName="${env.DATABASE_SERVER_NAME}" portNumber="${env.DATABASE_PORT_NUMBER}"
                user="${env.DATABASE_USER}" password="${env.DATABASE_PASSWORD}" sslConnection="true"/>

Refer to Database connections with TLS.

3. Configure jvm.options

Create jvm.options from <path_to_liberty>/wlp/usr/servers/<SERVER_NAME> directory.

Set the maximum heap size to 8192m. If the heap size is not big enough, IDA checkstyle may crash with an out-of-memory exception thrown. Increasing the heap size and restarting the server can fix this issue.

-Xms512m
-Xmx8192m

You might also need to set a proxy server, then add the following lines to jvm.options based on your actual proxy setting.

-Dhttps.proxyHost=host     
-Dhttps.proxyPort=port     
-Dhttps=proxyUser=user     
-Dhttps.proxyPassword=your password

4. Configure server.env (Optional)

Create server.env from <path_to_liberty>/wlp/usr/servers/<SERVER_NAME> directory.

The default IDA data folder is /var/ida/data. If the default value is not writable or not applicable, then add the following environment variable to server.env for your IDA data folder:

ENGINE_CONFIG_DATA_DIR=<your_ida_data_path>

5. Copy the ida-web.war to the apps directory

Copy the ida-web.war to <path_to_liberty>/wlp/usr/servers/<SERVER_NAME>/apps directory.

6. Start the Liberty server

<path_to_liberty>/wlp/bin/server start SERVER_NAME

7. Access IDA web application using HTTPS, for example, https://<IDA_HOST>:9443/ida

Installing on Docker Compose

Refer to ida-docker for deployment steps.

Installing on Openshift

Refer to ida-operator for deployment steps.

Migrating IDA Application from Java 8 to Java 17

To migrate IDA application from Java 8 to Java 17, please follow the steps above to install a new IDA application on Java 17. When configuring the data source for the new IDA application, point it to the same data source used by the old IDA application on Java 8. Below are the migration steps.

1. Stop the old IDA application on Java 8

2. Backup the database

3. Install a new IDA application on Java 17

Follow the steps above to install a new IDA application on Java 17. When configuring the data source for the new IDA application, point it to the same data source used by the old IDA application on Java 8.

4. Start the new IDA application on Java 17

After the new IDA application is started, login to verify the results. If database schema migration is required, follow the steps in Migrate database schema on IDA startup.