Prerequisites

From wiki.searchtechnologies.com
Jump to: navigation, search

For Information on Aspire 3.1 Click Here

Aspire requires Java 1.6 and a machine with an internet connection. We also strongly recommend installing the Maven command-line client for additional, very useful functionality (see below).

Install Java JDK 1.6

You will need Java 1.6 to run Aspire. We recommend installing the Java JDK (Java Development Kit), just in case you want to create your own Aspire components/applications in the future. But only the JRE (Java Runtime Environment) is absolutely required.


  1. Download and install the latest version of the Java 1.6 JDK: http://java.com/en/download/manual.jsp
    • If you have a 64 bit machine, we recommend installing the 64 bit version of Java. That will allow you to create large-memory instances of Aspire.
      • The Aspire framework itself does not use up that much memory (100mb or so). But some applications may store big hash tables to improve performance, so it's best to have the 64 bit JVM (Java Virtual Machine), just in case you need it someday.
  2. Test that you can access the "java" command from your console.
    JavaVersion.png
    1. Open up a new DOS command-shell (go to the start menu, and enter "cmd" where it says "Run" or "Search for Programs", and then execute the cmd.exe program).
    2. Enter: java -version
  3. Add the "JAVA_HOME" environment variable.
    SettingJavaHome.png
    • This is needed by the Maven command-line tool described below.
    1. Open up your control panel
    2. Go to the "System" control panel (may be inside the 'System and Security' category)
    3. Open up the "Advanced System Settings"
    4. Go to the "Advanced" tab (may already be selected)
    5. Click on "Environment Variables"
    6. Click on "New..."
    7. Enter "JAVA_HOME" as the "Variable name:"
    8. Locate the directory within your Program files where java was installed. Enter this directory name as the "Variable value:"


Install Maven Command-Line Tool

Installing the Maven command-line tool is strongly recommended, but not required.

With Maven command-line, you will be able to automatically build a wider range of Aspire distribution projects, including:

  • Distributions that work without an internet connection
  • Separate distributions for development, staging, QA, and production environments
  • Distributions that are bundled as "App Bundles" and can be re-used inside of other Aspire server instances.

In addition, the Maven command-line tool will be useful for creating new Aspire components and deploying these components to Maven repositories for use in other Aspire installations.

If you do not wish to install Maven command-line, you may download a pre-packaged set of Aspire binaries.

Detailed Instructions

  1. Download and install Apache Maven: http://maven.apache.org/download.html
    • Download and unpack the latest version
      • Suggestion: Create a "C:\dev" directory and store it in there.
      • "C:\dev" is a good place to store open source tools like Apache Maven, since (on rare occasions) they will not work with path names that have spaces in them.
  2. Add the "bin" directory from Apache Maven to your environment path.
    SettingPath.png
    Windows Instructions:
    1. Open up your control panel.
    2. Go to the "System" control panel (may be inside the 'System and Security' category).
    3. Open up the "Advanced System Settings".
    4. Go to the "Advanced" tab (may already be selected).
    5. Click on "Environment Variables".
    6. Add the bin directory on to the end of the PATH variable in the "System Variables" section.
      • Note that it needs to be preceded by a semi-colon.
      • For example:  ;C:\dev\apache-maven-3.0.4\bin
  3. Test that you can access maven.
    MavenVersion.png
    1. Open up a new command-shell (in Windows, go to the start menu, and enter "cmd" where it says "Run" or "Search for Programs", and then execute the cmd.exe program).
    2. Enter: mvn -version
    3. You should see roughly the same response as shown in the image to the right. -->