Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

Enterprise open source portal built by and for the higher education community.

branch: master
Octocat-spinner-32 assembly NOJIRA Fix quickstart max memory issue January 27, 2014
Octocat-spinner-32 bootstrap Merge pull request #280 from apetro/allow-jdk-8 April 17, 2014
Octocat-spinner-32 docs Fix mistypes November 06, 2013
Octocat-spinner-32 filters UP-3875: Add environment filters for cas context (/cas) and all param… January 21, 2014
Octocat-spinner-32 gource Update gource scripts June 25, 2012
Octocat-spinner-32 src Fix site templates September 28, 2011
Octocat-spinner-32 uportal-db [maven-release-plugin] prepare for next development iteration March 20, 2014
Octocat-spinner-32 uportal-ear [maven-release-plugin] prepare for next development iteration March 20, 2014
Octocat-spinner-32 uportal-platform-api [maven-release-plugin] prepare for next development iteration March 20, 2014
Octocat-spinner-32 uportal-portlets-overlay [maven-release-plugin] prepare for next development iteration March 20, 2014
Octocat-spinner-32 uportal-search-api [maven-release-plugin] prepare for next development iteration March 20, 2014
Octocat-spinner-32 uportal-war UP-4058: PortletCategoryRegistryLocator bean missing from locatorCont… April 18, 2014
Octocat-spinner-32 .gitignore Added node_modules/ and nom-debug.log March 20, 2014
Octocat-spinner-32 .springBeans UP-3146 Revert encoding/line ending fixes August 29, 2011
Octocat-spinner-32 .travis.yml Workaround allowing Travis-CI build to run. February 03, 2014
Octocat-spinner-32 CONTRIBUTING.md Updated CONTRIBUTING.md December 10, 2012
Octocat-spinner-32 LICENSE test June 02, 2010
Octocat-spinner-32 NOTICE Trivial: Fix "copywrite" --> "copyright". March 31, 2014
Octocat-spinner-32 NOTICE.template UP-3529 Adding Font Awesome icon set to notice file October 01, 2012
Octocat-spinner-32 README.md Drop JDK 1.6. Require 1.7 or later. April 07, 2014
Octocat-spinner-32 build.properties.sample Enable cleanShared by default August 31, 2011
Octocat-spinner-32 build.xml UP-3922 included latest pre-1.5.0 infusion build March 04, 2014
Octocat-spinner-32 findProperties.groovy UP-3477 Clean up properties after merge from UW July 10, 2012
Octocat-spinner-32 pom.xml NOJIRA: Bump jasig-widget-portlets.version to 2.0.2 April 18, 2014
Octocat-spinner-32 releaseNotes.html Also note JDK 1.7 requirement in release notes HTML template. April 08, 2014
README.md

For more detailed help please refer to the uPortal Manual

Additional information about uPortal is available on the uPortal Home Page or in the uPortal Wiki

Travis-CI Continuous Integration

uPortal uses Travis-CI for lightweight continuous integration. You can see build statuses at [https://travis-ci.org/Jasig/uPortal]. This handy image summarizes build status for the master branch:

Master Branch Build Status

Requirements

  • JDK 1.7 or later - Just a JRE is not sufficient, a full JDK is required
  • Servlet 2.5 Container - Tomcat 6.0 is recommended, there some configuration changes that must be made for Tomcat 6.0 which are documented in the uPortal manual.
  • Maven 3.0.3 or later
  • Ant 1.8.2

Building and Deploying

uPortal uses Maven for its project configuration and build system. An Ant build.xml is also provided which handles the initialization and deployment related tasks. As a uPortal deployer you will likely only ever need to use the Ant tasks. Ant 1.8.2 or later is required

Ant tasks (run "ant -p" for a full list) :

  • hsql - Starts a HSQL database instance. The default uPortal configuration points to this database and it can be used for portal development.
  • initportal - Runs the 'deploy-ear' and 'init-db' ant targets, should be the first and only task run when setting up a new uPortal instance WARNING: This runs 'init-db' which DROPS and re-creates the uPortal database
  • deploy-ear - Ensures the latest changes have been compiled and packaged then deploys uPortal, shared libraries and all packaged portlets to the container
  • initdb - Sets up the uPortal database. DROPS ALL EXISTING uPortal tables re-creates them and populates them with the default uPortal data WARNING: This DROPS and re-creates the uPortal database
  • deploy-war - Ensures the latest uPortal changes have been compiled and packaged then deploys the uPortal WAR to the container.
  • deployPortletApp - Deploys the specified portlet application to the container. This is the required process to deploy any portlet to a uPortal instance. ex: ant deployPortletApp -DportletApp=/path/to/portlet.war

Help and Support

The uportal-user@lists.ja-sig.org email address is the best place to go with questions related to configuring or deploying uPortal.

The uPortal manual is a collaborative document on the wiki which has more detailed documentation: https://wiki.jasig.org/display/UPM40

Other Notes

Initial Configuration

To deploy uPortal you must set the server.home variable in the build.properties file to the instance of Tomcat you want to deploy to.

Build approach

The approach here is that there is a generic pom.xml and build.xml that you should not have to edit, alongside a build.properties that you absolutely must edit to reflect your local configuration. Edit build.properties to reflect such configuration as where your Tomcat is, what context you would like uPortal to be deployed as, etc.

Initial Deployment

You must run the initportal target before uPortal is started the first time. This target will take care of compiling, deploying, database population and other initial tasks. Running initportal again is similiar to hitting a reset button on the portal. Any saved configuration in the portal is lost and a clean version of the portal is configured.

Logging

The /uportal-war/src/main/resources/logback.xml Logback configuration file will end up on the classpath for Logback to find. You'll need to either change that configuration then run deploy-war. You can configure the logging level, where the file should be, or even choose a different logging approach.

Database configuration

Database configuration is configured in /uportal-war/src/main/resources/properties/rdbm.properties

Something went wrong with that request. Please try again.