N2SM Software

==============================
 How to install on Jetspeed 2
==============================

 0. Install Jetspeed 2.1.3.

 1. Unzip N2Collabo-[versino].zip.

 2. Copy <N2COLLABO_HOME>/shared/lib/h2-*.jar to
    <JETSPEED2_HOME>/shared/lib.

  (On Unix-like OS)
  $ cp <N2COLLABO_HOME>/shared/lib/h2-*.jar <JETSPEED2_HOME>/shared/lib

 3. Copy portlets in <N2COLLABO_HOME>/war to
    <JETSPEED2_HOME>/webapps/jetspeed/WEB-INF/deploy/.

  (On Unix-like OS)
  $ cp <N2COLLABO_HOME>/war/*.war <JETSPEED2_HOME>/webapps/jetspeed/WEB-INF/deploy/

 4. Remove <JETSPEED2_HOME>/common/endorsed/*.jar.
    (N2 Collabo runs on Java 5 or above. These jar files
     break XML files for N2 Collabo.)

  (On Unix-like OS)
  $ rm <JETSPEED2_HOME>/common/endorsed/*.jar

 5. Change -Xmx256m to -Xmx512m -XX:MaxPermSize=256m in 
    <JETSPEED2_HOME>/bin/catalina.[sh|bat].

===============================
 Run Jetspeed 2 and N2 Collabo 
===============================

 1. Run DB for N2 Collabo.
    Use <N2COLLABO_HOME>/database/bin/run.[sh|bat].

  (On Unix-like OS)
  $ sh <N2COLLABO_HOME>/database/bin/run.sh

 2. Run Jetspeed 2.

  (On Unix-like OS)
  $ <JETSPEED2_HOME>/bin/startup.sh

===============================
 Replace with Userinfo Plugin
===============================

 If you replace with an userinfo plugin for Jetspeed 2,
 a user management(Userinfo) of N2 Collabo is able to be
 synchronized with one of Jetspeed 2. It means that you
 can create a user for both N2 Collabo and Jetspeed 2 at
 Userinfo of N2 Collabo.

 1. Stop Jetspeed 2.

  (On Unix-like OS)
  $ <JETSPEED2_HOME>/bin/shutdown.sh

 2. Replace userinfo-blank-plugin.jar with userinfo-j2-plugin.jar.

  (On Unix-like OS)
  $ rm <JETSPEED2_HOME>/webapps/userinfo/WEB-INF/lib/userinfo-blank-plugin-*.jar
  $ cp <N2COLLABO_HOME>/docs/jetspeed2/resources/userinfo-j2-plugin-*.jar
    <JETSPEED2_HOME>/webapps/userinfo/WEB-INF/lib/

 3. Run Jetspeed 2.

  (On Unix-like OS)
  $ <JETSPEED2_HOME>/bin/startup.sh

Note: when you create a new user, you need to create it
      with user role. To update admin user, need to add
      admin and user role to admin user.

===========================
 How to install on Liferay
===========================

 0. Install Liferay 5.1.

 1. Unzip N2Collabo-[versino].zip.

 2. Copy <N2COLLABO_HOME>/shared/lib/h2-*.jar to
    <LIFERAY_HOME>/shared/lib.

  (On Unix-like OS)
  $ cp <N2COLLABO_HOME>/shared/lib/h2-*.jar <LIFERAY_HOME>/shared/lib

 3. Copy portlets in <N2COLLABO_HOME>/war to
    Liferay's deploy directory(ex. ~/liferay/deploy).

  (On Unix-like OS)
  $ cp <N2COLLABO_HOME>/war/*.war ~/liferay/deploy

 4. Change -XX:MaxPermSize=128m to -XX:MaxPermSize=512m in 
    <LIFERAY_HOME>/bin/setenv.[sh|bat].

 5. (Optional) Change -Duser.timezone=GMT to
    -Duser.timezone=<YOUR_TIMEZONE> in
    <LIFERAY_HOME>/bin/setenv.[sh|bat].

============================
 Run Liferay and N2 Collabo 
============================

 1. Run DB for N2 Collabo.
    Use <N2COLLABO_HOME>/database/bin/run.[sh|bat].

  (On Unix-like OS)
  $ sh <N2COLLABO_HOME>/database/bin/run.sh

 2. Run Liferay.

  (On Unix-like OS)
  $ <LIFERAY_HOME>/bin/startup.sh

==============================
 How to install on PAL Portal
==============================

 0. Install PAL Portal 1.1.

 1. Unzip N2Collabo-[versino].zip.

 2. Copy <N2COLLABO_HOME>/shared/lib/h2-*.jar to
    <PALPORTAL_HOME>/shared/lib.

  (On Unix-like OS)
  $ cp <N2COLLABO_HOME>/shared/lib/h2-*.jar <PALPORTAL_HOME>/shared/lib

 3. Copy portlets in <N2COLLABO_HOME>/war to
    <PALPORTAL_HOME>/webapps/palportal/WEB-INF/deploy/.

  (On Unix-like OS)
  $ cp <N2COLLABO_HOME>/war/*.war <PALPORTAL_HOME>/webapps/palportal/WEB-INF/deploy/

 4. Change -Xmx256m to -Xmx512m in 
    <PALPORTAL_HOME>/bin/catalina.[sh|bat].

 5. (Optional) Unzip <N2COLLABO_HOME>/docs/palportal/resources/pages.zip
    in <PALPORTAL_HOME>/webapps/palportal/WEB-INF.

  (On Unix-like OS)
  $ cd <PALPORTAL_HOME>/webapps/palportal/WEB-INF
  $ unzip <N2COLLABO_HOME>/docs/palportal/resources/pages.zip


===============================
 Run PAL Portal and N2 Collabo 
===============================

 1. Run DB for N2 Collabo.
    Use <N2COLLABO_HOME>/database/bin/run.[sh|bat].

  (On Unix-like OS)
  $ sh <N2COLLABO_HOME>/database/bin/run.sh

 2. Run PAL Portal.

  (On Unix-like OS)
  $ <PALPORTAL_HOME>/bin/startup.sh

===============================
 Replace with Userinfo Plugin
===============================

 If you replace with an userinfo plugin for PAL Portal,
 a user management(Userinfo) of N2 Collabo is able to be
 synchronized with one of PAL Portal. It means that you
 can create a user for both N2 Collabo and PAL Portal at
 Userinfo of N2 Collabo.

 1. Stop PAL Portal.

  (On Unix-like OS)
  $ <PALPORTAL_HOME>/bin/shutdown.sh

 2. Replace userinfo-blank-plugin.jar with
    userinfo-palportal-plugin.jar.

  (On Unix-like OS)
  $ rm <PALPORTAL_HOME>/webapps/userinfo/WEB-INF/lib/userinfo-blank-plugin-*.jar
  $ cp <N2COLLABO_HOME>/docs/palportal/resources/userinfo-palportal-plugin-*.jar 
    <PALPORTAL_HOME>/webapps/userinfo/WEB-INF/lib/

 3. Run PAL Portal.

  (On Unix-like OS)
  $ <PALPORTAL_HOME>/bin/startup.sh

Note: when you create a new user, you need to create it
      with user role. To update admin user, need to add
      admin and user role to admin user.