Essentials Overview Features License Installation FAQ Sample Sites Resources Todo Changes Download Binaries Source Code Supporting Projects Documentation Configuration Guide Javadocs Development Portlet Howto Portlet Catalog Jetspeed Trailmap Components Registry Security Syndication WAP Customization Cache PSML Get Involved Contributors CVS Repository CVS Branches Coding Spec Bug Database |
Table of Contents
Requirements Downloading A Release Build Downloading A Nightly Build Checkout from CVS Installation Database Configuration Servlet Container Notes
Requirements
A Java Servlet Engine/Container. Must be compatible with the Servlet 2.2 or Servlet 2.3 API. Note: Jetspeed is developed under Tomcat which is available from http://jakarta.apache.org/tomcat JDK 1.3 or higher Java Virtual Machine. Jetspeed has been tested on most SUN and IBM Virtual Machines. Note: if JDK 1.3 Standard Edition is used, the following must also be installed: Java API for XML Processing (JAXP) - Jetspeed 1.4b2 only JDK 1.2 can be used with the addition of the following components: Java API for XML Processing (JAXP) - Jetspeed 1.4b2 only Java Naming and Directory Interface (JNDI) JavaBeans Activation Framework (JAF) - included in JDK 1.2 Enterprise Edition
Downloading A Release Build
> When downloading a release build, there are three kinds of builds that you can download: Full WAR - Gives you the entire Web Application including all documentation and javadocs. WAR - Gives you the Web Application and documentation minus the javadocs. Source - Gives you the source code and resources. You will need to build Jetspeed yourself. The WAR and Full WAR downloads do not require for you to build Jetspeed. The Web Application is ready to deploy to your application server in a Web Archive (WAR) format.
> Release 1.4b1 (Latest) | Download From:
> --- | ---
> Jetspeed Release 1.4b1 - Full WAR | jetspeed-1.4b1-release-fullwar.zip
> Jetspeed Release 1.4b1 - Standard WAR | jetspeed-1.4b1-release-war.zip
> Jetspeed Release 1.4b1 - Source Only | jetspeed-1.4b1-release-src.zip
> Release 1.3a2 | Download From:
> --- | ---
> Jetspeed Release 1.3a2 - Full WAR | jetspeed-1.3a2-release-fullwar.zip
> Jetspeed Release 1.3a2 - Standard WAR | jetspeed-1.3a2-release-war.zip
> Jetspeed Release 1.3a2 - Source Only | jetspeed-1.3a2-release-src.zip
Downloading A Nightly Build
The Jetspeed Nightly Builds are automatically updated from CVS every night on the Jakarta server. Each zip file is a snapshot of the entire CVS at the end of the given day. You will need to build Jetspeed from the nightly snapshots. The last seven builds are available for download in both GZIP and ZIP formats. The last seven builds are available from here: Nightly Builds
Checkout from CVS
The best way to get the latest Jetspeed source is to checkout directly from CVS. Follow the Jakarta CVS instructions available here and checkout the jakarta-jetspeed module. cvs -d :pserver:anoncvs@cvs.apache.org:/home/cvspublic login password: anoncvs cvs -d :pserver:anoncvs@cvs.apache.org:/home/cvspublic checkout jakarta-jetspeed To check for a particular date, use the -D option: cvs -d :pserver:anoncvs@cvs.apache.org:/home/cvspublic checkout -D 2002-06-04 jakarta-jetspeed
Installation
This installation procedure covers installing Jetspeed as a J2EE Web Application. Installing a Web application is simple. With Web apps, the entire application can be contained in a single archive file and deployed by placing the file into a specific directory. Here are the complete steps for downloading Jetspeed, building it, and then installing the default Web Application. 1. Download or Checkout Jetspeed as described in one of the three sections above. 2. Build Jetspeed - Skip this step if you downloaded a WAR release version of Jetspeed. cd <jetspeedRoot>/build [Win32/DOS] .\build war [Win32/cygnus] bash build.sh war [unix] ./build.sh war 3. Download Tomcat or another standard 2.2 or 2.3 compatible Servlet Container. We use Jakarta Tomcat in the examples here. Tomcat Homepage 4. Install the Tomcat distribution - Follow the instructions at the Tomcat site. 5. Copy the Jetspeed WAR file to the Tomcat webapps directory [Win32] copy <jetspeedRoot>\bin\jetspeed.war <tomcat_home>\webapps\ [Unix] cp <jetspeedRoot>/bin/jetspeed.war <tomcat_home>/webapps/ 6. Start Tomcat [Win32] <tomcat_home>\bin\startup.bat [Unix] <tomcat_home>/bin/startup.sh 7. Connect to Jetspeed http://localhost:8080/jetspeed/ There are 2 default accounts created: Login: turbine Password: turbine Login: admin Password: jetspeed 7a. When signing up a new user in Jetspeed, the registration process includes a step where an email is sent to the new user. In order for this process to work on Windows NT or 2000, you will need to have a local SMTP server running. The Apaches James Mail Enterprise Server is available from: http://jakarta.apache.org/james/ The mail host settings will need to be modified: <tomcat_home>/webapps/jetspeed/WEB-INF/conf/TurbineResources.properties
Database Configuration
> The default Jetspeed deployment uses its own security model to authorize users and persist minimal user information. Turbine security should work with any JDBC 2.0 compliant driver. The following databases are tested: DB2 Hypersonic SQL MySQL Oracle Postgres Sybase Jetspeed is distributed with a populated Hypersonic-SQL database. This database is selected as the default database in the TorqueResources.properties file. To configure Jetspeed with a different database, modify the TurbineResources.properties file. Here is an example for Oracle: database.default.driver=oracle.jdbc.driver.OracleDriver database.default.url=jdbc:oracle:thin:@<host>:1521:<sid> database.default.username= <your-oracle-user> database.default.password= <your-password> database.adaptor=DBOracle database.adaptor.DBOracle=oracle.jdbc.driver.OracleDriver You will need to replace:
> <host> | the host of the Oracle instance, such as localhost
> <sid> | the name of Oracle database sid at the host
> <username> | the oracle user(schema) name
The TorqueResources.properties file can be found in /webapp/WEB-INF/conf. The database scripts for setting up the database are included with the source code distribution, under the src/sql/external folder. Run the appropriate script, such as turbine-db2.sql for DB2, to create the database tables. This step is not necessary with Hypersonic SQL. To populate the database, scripts are provided: /src/sql/external/populate*.sql. Only run the statements for your specific database as commented. The script will create two database users: Login: turbine Password: turbine Login: admin Password: jetspeed
PSML Database
If you would also like to store your PSML resources in the database, see the instructions here.
Servlet Container Notes
> Orion Application Server
> You may need to alter the url-pattern to /portal, from /portal/*, in Jetspeed's web.xml. This was report by user of Orion Application Server v1.5.2. See the Jetspeed Developer mailing list for more information.
> Tomcat v3.3.1
> Jetspeed works "out of the box"
> Tomcat v4.0.3 and v4.0.4
> Copy xerces.jar from common/lib to lib. Webapps that requires xerces must provide their own copy, like Jetspeed.
> Tomcat v4.1.12
> Jetspeed works "out of the box"
Copyright © 1999-2002, Apache Software Foundation