This documentation relates to uPortal 3.2
If you are using a different version, please click on "Click for all versions" on the left side of the page and select the relevant version.

Requirements

Skip to end of metadata
Go to start of metadata
All Versions
Table of Contents

uPortal Environment Requirements

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

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

Installing Apache Maven

Unix/Linux Maven Installation
  1. Download Maven
  2. Extract the archive (apache-maven-2.2.x-bin.tar.gz) in the directory you wish to install Maven
    tar -xvf apache-maven-2.2.x-bin.tar.gz
    
  3. Add the M2_HOME environment variable
    export  M2_HOME=/path/to/apache-maven/apache-maven-2.2.x
    
  4. Add the M2 environment variable
    export  M2=$M2_HOME/bin
    
  5. Add M2 environment variable to your path
    export  PATH=$M2:$PATH
    
  6. Make sure that JAVA_HOME is set to the location of your JDK and add to to your path
    export JAVA_HOME=/path/to/java/jdk1.6.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-2.2.x-bin.zip to the directory you wish to install Maven (i.e., C:
    Program Files\Apache Software Foundation)
    unzip apache-maven-2.2.x.bin.zip
    
  3. Add the M2_HOME environment 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-2.2.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.6.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
  2. Extract the archive in the directory you wish to install Apache Ant
    //extracting tar.gz archive
    tar -xvf apache-ant-1.7.x-bin.tar.gz
    
  3. Add the ANT_HOME environment variable
    export ANT_HOME=/path/to/apache-ant-1.7.x
    
  4. Make sure the JAVA_HOME environment variable is setup
    export JAVA_HOME=/usr/local/jdk-1.6.x
    
  5. Add the ANT_HOME to the PATH variable
    export PATH=$PATH:$ANT_HOME/bin
    
  6. Confirm that your Ant installation is working by running the following command
    ant -version
    

Having problems with these instructions?

Please send us feedback at uportal-user@lists.ja-sig.org

  • No labels