Copyright 2004 The Apache Software Foundation

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

-------------------------------------------------------------------------------
Requirements
-------------------------------------------------------------------------------

1. A Java Servlet Engine/Container.  

Must be compatible with the Servlet 2.2 API.
Note that Jetspeed is developed under Tomcat (http://jakarta.apache.org), so 
this is the most desirable platform.  

JDK 1.2 or higher Java Virtual Machine.  

Jetspeed has been tested on most SUN and IBM Virtual Machines.


-------------------------------------------------------------------------------
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. Build Jetspeed
-----------------------

cd <jetspeedRoot>

maven war

----------------------------------------
2. Get a Servlet 2.2 runner (container) 
-----------------------------------------

We use Tomcat in this installation.
The Tomcat homepage can be found at: http://jakarta.apache.org/tomcat/

--------------------------------
3. Unzip the Tomcat distribution
--------------------------------


--------------------------------------------------------------
4. Copy the Jetspeed WAR file to the Tomcat webapps directory
---------------------------------------------------------------

[Win32]  copy <jetspeedRoot>\target\jetspeed.war <tomcat_home>\webapps\

[Unix]   cp <jetspeedRoot>/target/jetspeed.war <tomcat_home>/webapps/



----------------
5. Start Tomcat
----------------

[Win32]   <tomcat_home>\bin\startup.bat

[Unix]    <tomcat_home>/bin/startup.sh


-----------------------
6. Connect to Jetspeed
-----------------------

 From your browser, go to:

   http://localhost:8080/jetspeed/


 There are 2 default accounts created for you to logon with:
  

   Login: turbine Password: turbine

   Login: admin Password: jetspeed
  

---------------------------
7a.  New User Registration
---------------------------

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
-------------------------------------------------------------------------------

Jetspeed uses Jakarta Torque to store users and persist minimal 
user information. This security model 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. 

To configure Jetspeed with a different database, modify BOTH, the 
project.properties file in the Jetspeed root directory and the webapp/WEB-INF/conf/Torque.properties file. 

Here is an example for MySQL:

torque.database.default.adapter=mysql
torque.dsfactory.default.connection.driver = org.gjt.mm.mysql.Driver
torque.dsfactory.default.connection.url = jdbc:mysql://localhost:3306/jetspeed
torque.dsfactory.default.connection.user =  root
torque.dsfactory.default.connection.password = 


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, a script is 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