Requirements

uPortal Environment Requirements

To build and run uPortal full-source version , you will need the following:

• Java 1.6 Update 21 (or later)orJava 7
• Maven 3.0.3+
• Ant 1.8.2
• The Servlet Container (such as Tomcat 6.x or 7.x)
• Database

Read the Apereo uPortal Upgrade and Compatibility Notes for more information.

To build and run the uPortal quick-start version, download the quick-start version and continue to the Building and Deploying uPortal instructions.

Installing Java

Install Java on your system per standard procedures for your system.  Insure that the account running Tomcat uses the JVM of choice if not the system-installed version.

For Dev, Test, and Production systems, also see JVM options you may want to configure from the JVM Configuration and Tuning page.

Installing Apache Maven

Unix/Linux Maven Installation

1. Download Maven

2. Extract the archive (apache-maven-3.0.x-bin.tar.gz) in the directory you wish to install Maven

   tar -xvf apache-maven-3.0.x-bin.tar.gz
   

3. Add the M2_HOME environment variable

   On Ubuntu, by default Maven is typically found under /usr/share/maven2

   export  M2_HOME=/path/to/apache-maven/apache-maven-3.0.x
   

4. Add the M2environment variable

   export  M2=$M2_HOME/bin
   

5. Add M2environment variable to your path

   export  PATH=$M2:$PATH
   

6. Make sure that JAVA_HOMEis set to the location of your JDK and add to to your path

   export JAVA_HOME=/path/to/java/jdk1.x
   export PATH=$JAVA_HOME/bin:$PATH
   

7. Run the following command to verify that it is correctly installed

   mvn --version
   

Windows Maven Installation

1. Download Maven

2. Unzip the archive, apache-maven-3.0.x-bin.zip to the directory you wish to install Maven (i.e., C:
   Program Files\Apache Software Foundation)

   unzip apache-maven-3.0.x.bin.zip
   

3. Add the M2_HOMEenvironment variable
   
   • open up the system properties (WinKey + Pause)
   • select the "Advanced" tab
   • click the "Environment Variables" button
   • add the M2_HOME variable in the user variables with the value C:\Program Files\Apache Software Foundation\apache-maven-3.0.x
4. Add the M2 environment variable the same as Step 3.  In the user variables enter the value %M2_HOME%\bin.
5. Update/Create the Path environment variable using the same process as above. In the user variables, prepend the value %M2% to allow Maven to be available in the command line.
6. Same as above, make sure that JAVA_HOME exists in your user variables or in the system variables and set the location of your JDK (C:\Program Files\Java\jdk1.x)
7. Update the Path environment variable to include %JAVA_HOME%\bin using the Step 3 instructions.
8. Open a new command prompt (Winkey + R then type cmd) and run mvn --version to verify that it is correctly installed.

Installing Apache Ant

1. Download Apache Ant (it needs to be version 1.8.2; you can get that older version of Ant here: http://archive.apache.org/dist/ant/binaries/ )

2. Extract the archive in the directory you wish to install Apache Ant

   //extracting tar.gz archive
   tar -xvf apache-ant-1.8.x-bin.tar.gz
   

3. Add the ANT_HOMEenvironment variable

   export ANT_HOME=/path/to/apache-ant-1.8.x
   

4. Make sure the JAVA_HOMEenvironment variable is setup

   export JAVA_HOME=/usr/local/jdk-1.x
   

5. Add the ANT_HOME to the PATHvariable

   export PATH=$PATH:$ANT_HOME/bin
   

6. Confirm that your Ant installation is working by running the following command

   ant -version