Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

Step-By-Step Installation Guide

  1. If you're feeling adventurous, download the bleeding-edge source from trunk:

    Code Block
    git svnclone export https://sourcegithub.com/jasig.org/portlets/AnnouncementsPortlet/trunk/ announcements-portlet
    

    If you aren't feeling adventurous, use the most stable tagged release, currently 1.1-M1:

    Code Block
    
    svn export https://source.jasig.org/portlets/AnnouncementsPortlet/tags/git clone announcements-portlet
    
    git checkout 1.1-M1/ announcements-portlet
    
  2. Make sure you have Maven2 installed and that you can run the following command from your command line:

    Code Block
    
    mvn -version
    
  3. Make sure the javascript.jQuery.include property in src/main/resources/configuration.properties is set to the correct value: true for uPortal 3.1 or later or any portal that does not provide jQuery in the global JavaScript namespace; false for uPortal 3.0.x or any portal that provides jQuery in the global JavaScript namespace. The default is true. This setting allows Ajax features in the portlet to function properly.
  4. If you are only testing the portlet, skip this step; otherwise, edit the datasource.properties file to reflect your database settings and add your JDBC driver to the pom.xml.
  5. In the announcements-portlet directory, run

    Code Block
    
    mvn package
    
  6. Once the project is built, you'll have a file called Announcements.war in the target directory.
  7. Deploy the portlet by running

    Code Block
    
    ant deployPortletApp -DportletApp=/path/to/Announcements.war
    

    ...in the uPortal source directory on your target server.

  8. Add the two portlets to your portal:
    • uPortal 2.5.x and 2.6.x format:
      • Announcements.AnnouncementsDisplay
      • Announcements.AnnouncementsAdmin
    • uPortal 3 format:
      • Portlet Web Application Path: /Announcements
        Portlet Name: AnnouncementsDisplay
      • Portlet Web Application Path: /Announcements
        Portlet Name: AnnouncementsAdmin
  9. Restart Tomcat if you get any fussiness from the portlet.  If you have issues, ask us on the portlet-dev mailing list.

...

Use the disableJspc maven profile to build the Announcements Portlet without the JSPC Maven Plugin

Code Block

mvn clean package -P disableJspc

...