Skip to content
Enterprise open source portal built by and for the higher education community.
Java XSLT JavaScript Groovy Shell Perl
Find file
New pull request
Fetching latest commit...
Cannot retrieve the latest commit at this time.
Failed to load latest commit information.


README for basic uPortal deployment

For further help please refer to the uPortal home page or
the uPortal Confluence site

| Requirements                                                                 |
JDK 1.6 - Just a JRE is not sufficent, 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
Maven 2.2.1 or later
Ant 1.7.1
| 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. Note that Ant 1.7.0 has a SERIOUS bug and will NOT work with uPortal,
use Ant 1.7.1.

Ant tasks:
    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
    deploy-ear - Ensures the latest changes have been compiled and packaged then
        deploys uPortal, shared libraries and all packaged portlets to the
    init-db - 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 email address is the best place to go with 
questions related to configuring or deploying uPortal. Information about joining
the list is available on the JA-SIG wiki:

Additionaly there is a collaborative manual in progress on the wiki which has
some HOWTO and related documentation:

| Other Notes                                                                  |

Initial Configuration
To deploy uPortal you must set the server.home variable in the 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 that you absolutely must
edit to reflect your local configuration. Edit 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.

The /uportal-war/src/main/webapp/WEB-INF/ Log4j configuration
file will end up on the classpath for Commons Logging / log4j 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 (log via XML to a ChainSaw instance, say).

Database configuration
Database configuration is configured in /uportal-impl/src/main/resources/properties/ 
Something went wrong with that request. Please try again.