Skip to end of metadata
Go to start of metadata

You are viewing an old version of this content. View the current version.

Compare with Current View Version History

Version 1 Current »

Prerequisites

  1. Supported platforms: *NIX - Unix/Linux/OSX, Solaris, Windows
  2. JDK 6 or 7 installed (http://www.oracle.com/technetwork/java/javase/downloads/index.html)

    Set the JAVA_HOME environment variable to the location where the JDK is installed.

    Example on how to set JAVA_HOME on *NIX
    JAVA_HOME=/usr/java/jdk1.6.0
export JAVA_HOME
 
    Example on how to set JAVA_HOME on Windows
    set JAVA_HOME=C:\Program Files\Java\jdk1.6.0

    *NIX

    Unlink /usr/bin/java if it is already linked to a previous version of the JRE:
    unlink /usr/bin/java

    Verify the JAVA_HOME was set correctly

    *NIX
    echo $JAVA_HOME
    Windows
     echo %JAVA_HOME%
  3. DDF installation zip file
  4. A web browser

  5. For Linux systems increase the file descriptor limit

    Edit /etc/sysctl.conf and add or modify the following. 

    fs.file-max = 6815744

    Restart

    For the change to take affect a restart is required.

    Restart command
    init 6

The Administration Web Console is not compatible with Internet Explorer

 

 

 

Installation Guide

The *NIX commands listed next to the steps were performed on a default installation of Red Hat Enterprise Linux 5.4. Permission maintenance is not mentioned in this article, but all files should be owned by the running user regardless of platform.

Although DDF can be installed by any user it is recommended for security reasons to have a non-root user execute the DDF installation.

Install

  1. After the prerequisites have been met, (as a root user if for *NIX) change the current directory to the desired install location. This will be referred to as <INSTALL_DIRECTORY>.

    *NIX Tip

    It is recommended that the root user create a new install directory that can be owned by a non-root user (e.g. ddf-user). The non-root user (e.g. ddf-user) can now be used for the remaining installation instructions. 

    Example: create a directory and switch user on *NIX
    mkdir new_installation
chown ddf-user:ddf-group new_installation

su - ddf-user

  2. Change the current directory to location of zip file (ddf-X.Y.zip).

    Example in *NIX where the zip file could be located
    cd /home/user/cdrom
    Windows (Example assumes DDF has been downloaded to the D drive)
    cd D:\

  3. Copy ddf-X.Y.zip to <INSTALL_DIRECTORY>

    *NIX
    cp ddf-X.Y.zip <INSTALL_DIRECTORY>
    Windows
    copy ddf-X.Y.zip <INSTALL_DIRECTORY>

  4. Change the current directory to the desired install location

    *NIX or Windows
    cd <INSTALL_DIRECTORY>

  5. The ddf zip should now be located within the <INSTALL_DIRECTORY>. Unzip ddf-X.Y.zip.

    *NIX
    unzip ddf-X.Y.zip
    Example of using Java to unzip in Windows
    "C:\Program Files\Java\jdk1.6.0\bin\jar.exe" xf ddf-X.Y.zip

  6. Run ddf by using the appropriate script.

    *NIX
    <INSTALL_DIRECTORY>/ddf-X.Y/bin/ddf
    Windows
    <INSTALL_DIRECTORY>/ddf-X.Y/bin/ddf.bat

  7. Wait for the console prompt to appear. 

    Command prompt when initially loaded
    ddf@local>

    The distribution takes a few moments to load up depending on the hardware configuration. Execute the following command at the command line for status

    ddf@local>list

    Proceed to Configuration.

Configuration

  1. Open a compatible web browser and log in to the Administration Web Console (http://localhost:8181/system/console) with username: admin and password: admin.  
  2. Select the Configuration tab in the Administration Web Console.
    1. Click on the item labeled "Platform Global Configuration".  
      1. Enter the IP address or hostname of the installation in the "Host" field. 
      2. Enter 8181 for the "Port" field. The port can be changed later if desired.
      3. Enter the site name (i.e., the name DDF will return in federation and web service responses).
      4. Click Save.
    2. Click on the item labeled "Catalog Sorted Federation Strategy".  
      1. Enter the maximum query offset number in the "Maximum start index" field or just keep the default setting. Refer to Standard Catalog Framework for additional info.
      2. Click Save.  

Verification

At this point, DDF should be up and running with a Solr Catalog Provider. New features (endpoints, services, and sites) can be added as needed.

Verification can be achieved by checking that all of the DDF bundles are in an Active state (excluding fragment bundles which remain in a Resolved state).

The following command can display the status of all the DDF bundles:

ddf@local>list | grep -i ddf

If displayed, the DDF :: Distribution :: Web Console entry should be in the Resolved state. This is expected. The DDF Distribution Web Console is an OSGi bundle fragment. Bundle fragments are distinguished from other bundles in the command line console list by a new line under the its bundle status that states "Hosts," followed by a bundle number. Bundle fragments remain in the Resolved state and can never move to the Active state.

What a Bundle Fragment looks like in the Command Line Console
[ 261] [Resolved   ] [            ] [       ] [   80] DDF :: Distribution :: Web Console (2.2.0)
                                       Hosts: 76

For a complete list of installed features/bundles see the DDF Included Features document.

 

Troubleshooting

Exception Starting DDF

Problem: Following exception is thrown starting DDF on a Windows machine (x86)

Using an unsupported terminal: java.lang.NoClassDefFoundError: Could not initialize class org.fusesource.jansi.internal.Kernel32

Solution:  Install missing Windows libraries.  

Some Windows platforms are missing libraries needed by DDF.  These libraries are provided by the Microsoft Visual C++ 2008 Redistributable Package x64.

  • No labels