Java JavaScript CSS XSLT HTML Groovy Other
Permalink
Failed to load latest commit information.
assembly Clarify : ant.sh / ant.bat rather than bare ant. May 1, 2015
bootstrap Merge branch 'master' into NOJIRA-gitingore-cleanup Sep 19, 2016
docs UP-4792: Modest updates from PR feedback Feb 17, 2017
filters UP-4733: For non-production deployments, configure setting logAbandon… Sep 26, 2016
gource UP-4361 license header "Apereo" rather than "Jasig". Dec 30, 2014
gradle/wrapper UP-4179: Update distributionUrl in gradle-wrapper.properties to use t… Sep 6, 2016
src/site UP-4361 license header "Apereo" rather than "Jasig". Dec 30, 2014
uPortal-core UP-4179: grep for org.jasig.portal and verify that remaining occurren… Sep 15, 2016
uPortal-rdbm UP-4179: Add the following (3) Gradle-based submodules and move some … Sep 7, 2016
uPortal-soffit-connector UP-4792: Modest updates from PR feedback Feb 17, 2017
uPortal-soffit-renderer UP-4792: Modest updates from PR feedback Feb 17, 2017
uPortal-soffit UP-4792: Modest updates from PR feedback Feb 17, 2017
uPortal-utils UP-4179: (Interim step) move remaining items out of uportal-war/src/t… Sep 15, 2016
uportal-db UP-4780: Update MS SQL Server driver coordinates to new open source v… Dec 8, 2016
uportal-ear Merge branch 'master' into NOJIRA-gitingore-cleanup Sep 19, 2016
uportal-platform-api UP-4179: (Interim step) move packages 'org.jasig.portal.aggr' and 'or… Sep 7, 2016
uportal-portlets-overlay UP-4794: Update NewsReader portlet to version 4.2.2 Jan 25, 2017
uportal-search-api Merge branch 'master' into NOJIRA-gitingore-cleanup Sep 19, 2016
uportal-war UP-4788: Make the dropdown toggle wider -- more 'touchable' -- on sma… Feb 22, 2017
.gitignore Theme the GitHub Page website (#817) Jan 31, 2017
.springBeans UP-3146 Revert encoding/line ending fixes Aug 29, 2011
.travis.yml NOJIRA: Test uPortal 5 with Java 8 compiler Jan 5, 2017
CONTRIBUTING.md UP-4749: Resolve RemarkLint warnings Jan 3, 2017
LICENSE test Jun 2, 2010
NOTICE Acknowledge redistribution of furley_bg.png in NOTICE. (#789) Dec 29, 2016
NOTICE.template Change labels and URLs from Jasig to Apereo. Apr 18, 2014
PULL_REQUEST_TEMPLATE.md UP-4804: Add internationalization and accessibility to PR checklist Feb 21, 2017
README.md NOJIRA: Add accessibility summary in README Jan 17, 2017
build.gradle UP-4792: Refector to create new service 'ModelAttributeService'; add … Feb 17, 2017
build.properties.sample NOJIRA: Possibility setting env from build.properties Aug 16, 2016
build.xml If the Gradle build fails, fail the Ant build Feb 21, 2017
checkstyle-suppression.xml UP-4747: Add checkstyle suppression file Dec 29, 2016
checkstyle.xml UP-4747: Add checkstyle suppression file Dec 29, 2016
findProperties.groovy UP-4361 license header "Apereo" rather than "Jasig". Dec 30, 2014
gradle.properties UP-4792: Refector to create new service 'ModelAttributeService'; add … Feb 17, 2017
gradlew UP-4179: Add a Gradle Wrapper based on the latest version of Gradle t… Sep 6, 2016
gradlew.bat UP-4179: Add a Gradle Wrapper based on the latest version of Gradle t… Sep 6, 2016
package.json Merge branch 'master' into UP-4749 Feb 16, 2017
pom.xml UP-4798: Update Announcements portlet to version 2.2.3 Jan 31, 2017
releaseNotes.html UP-4209 require Servlet3 / Tomcat 7+. Dec 30, 2014
settings.gradle UP-4179: Add the following (3) Gradle-based submodules and move some … Sep 7, 2016

README.md

uPortal

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

Accessibility

uPortal strives to conform with Web Content Accessibility Guidelines Version 2.0 Level AA. The most recent accessility audit results can be seen in UP-4735.

WCAG 2 AA Badge

Requirements

  • JDK 1.8 - The JRE alone is NOT sufficient, a full JDK is required
  • Servlet 3.1 Container - Tomcat 8.0 is required. (NOTE: Tomcat 7 may continue to workin the early 4.3 period. We reserve the right to use leverage Servlet 3.1, JSP 2.3, EL 3.0 and Web Socket 1.1) There some configuration changes that must be made for Tomcat which are documented in the uPortal manual.
  • Maven 3.2.2 or later
  • Ant 1.8.2 or 1.9.3 or later.

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 1.9.3 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.
ant deployPortletApp -DportletApp=/path/to/portlet.war

Help and Support

The uportal-user@apereo.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/UPM42

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 similar 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 connection information is read from /uportal-war/src/main/resources/properties/rdbm.properties, but is normally configured in filters/{environment.name}.properties.