Building and Deploying Instructions for:
...
uPortal Full-Source Version
- Download the latest version of uPortal from the downloads page
| Code Block | ||
|---|---|---|
| ||
wget http://downloads.jasig.org/uportal/uPortal-4.1.x/uPortal-4.1.x.tar.gz |
- After you have downloaded uPortal, unpack the uPortal source outside the Tomcat container (i.e., /usr/local/src or any directory outside tomcat)
| Code Block |
|---|
tar -xvf uPortal-4.1.x.tar.gz |
...
Step 1: Configure the build.properties file
The uPortal build requires a build.properties file describing the deployment environment to be available in the root of the uPortal project.
1. Go to your uPortal source directory and create the build.properties file by copying the build.properties.sample file to build.properties
...
Step 2: Configure filters
...
In the filters folder, locate the default local.properties file and configure the Database Connection Settings, uPortal Server Configuration Properties, CAS Server Configuration, Logging information, and LDAP settings. Replace localhost:8080 with your server name.
uPortal provides an optional mechanism to override these settings with a file that is completely outside uPortal source. This approach allows systems administrators to change these settings without rebuilding. It also provides an easy way for adopters to keep sensitive information outside of their Source Code Management system (See Properties Files and Properties Overrides).
...
| Code Block |
|---|
## HSQL Configuration
environment.build.hsql.port=8887
## Database Connection Settings (Uncomment the Maven Filters section in rdbm.properties)
environment.build.hibernate.connection.driver_class=org.hsqldb.jdbc.JDBCDriver
environment.build.hibernate.connection.url=jdbc:hsqldb:hsql://localhost:${environment.build.hsql.port}/uPortal
environment.build.hibernate.connection.username=sa
environment.build.hibernate.connection.password=
environment.build.hibernate.dialect=org.hibernate.dialect.HSQLDialect
# uPortal server configuration properties
environment.build.uportal.server=localhost:8080
environment.build.uportal.protocol=http
environment.build.uportal.context=/uPortal
environment.build.uportal.email.fromAddress=portal@university.edu
# CAS server configuration properties
environment.build.cas.server=localhost:8080
environment.build.cas.protocol=http
# Log4J values applied to portlets and portals. See log4j.properties file
# in WEB-INF or resources directory for each portlet. This provides a
# single point of control for most logging.
environment.build.log.rootLevel=INFO
# Directory to place portal and portlet log files into.
environment.build.log.logfileDirectory=${catalina.base}/logs
# Assume a DailyRollingFileAppender is used. Set the pattern to daily log-file roll-overs.
# Can also set to hourly, weekly, etc. Use yyyy-MM-dd-HH for hourly.
# See http://logging.apache.org/log4j/1.2/apidocs/org/apache/log4j/DailyRollingFileAppender.html
environment.build.log.rollingLogFileDatePattern=yyyy-MM-dd
# Pattern to specify format of each log file entry. See http://logging.apache.org/log4j/1.2/apidocs/index.html.
environment.build.log.layoutConversionPattern=%5p [%t] %c{2}.[%x] %d{ISO8601} - %m%n
environment.build.logback.layoutConversionPattern=%-5level [%thread] %logger{36} %d{ISO8601} - %msg%n
# LDAP server connection settings (optional)
# To connect to LDAP, provide your connection information here and uncomment one
# or both integration beans in uportal-war/src/main/resources/properties/contexts/ldapContext.xml
environment.build.ldap.url=
environment.build.ldap.baseDn=
environment.build.ldap.userName=
environment.build.ldap.password=
|
Optional: Creating multiple filter files per environment
...
Shared Sessions
- Jasig portlets, as well as many other popular JSR-168 portlets, rely on the ability to share user session data between the portal web application and portlet applications. To enable this feature:
- Tomcat 6.0: add the emptySessionPath="true" parameter to the in-use connector (configured in Tomcat in CATALINA_BASE/conf/server.xml).
- Tomcat 7.0: add the "sessionCookiePath="/" to CATALINA_BASE/conf/context.xml.
- Jasig portlets, as well as many other popular JSR-168 portlets, rely on the ability to share user session data between the portal web application and portlet applications. To enable this feature:
| Code Block | ||
|---|---|---|
| ||
<Connector port="8080" protocol="HTTP/1.1"
connectionTimeout="20000" redirectPort="8443" emptySessionPath="true"/> |
...
| Warning |
|---|
WARNING: Running the following command will reinitialize your database by dropping all tables first. Your content will be lost if you run against an existing database. |
- Run the following command to deploy uPortal and load your database
| Code Block |
|---|
ant initportal |
Step 6: Restart Tomcat
...
| Code Block |
|---|
$TOMCAT_HOME/bin/shutdown.sh
$TOMCAT_HOME/bin/startup.sh
|
Step 7: Access uPortal
| Code Block |
|---|
http://localhost:8080/uPortal/ |
...
| Code Block |
|---|
tar -xvf uPortal-4.1-quick-start.tar.gz |
...
Step 2: Set up JAVA_HOME
Make sure the JAVA_HOME environment variable is set
...