Kuali OLE 1.0 Installation Documentation - In the works!!!

Kuali Open Library Environment (KOLE) 1.0 can be downloaded directly from maven central or checked out from the svn repository. 

1. Obtaining the software :

1. Directly downloading the deployable units:
   1. olefs-webapp-1.0.0.war : This artifact deals with the financial and library management features and can be downloaded from http://shrub.appspot.com/maven.kuali.org/release/org/kuali/ole/olefs-webapp/1.0.0/
   2. oledocstore-webapp-1.0.0.war: This deals with the cataloging/indexing and searching of Bibliographic, Holdings and Item data and can be downloaded from http://shrub.appspot.com/maven.kuali.org/release/org/kuali/ole/olefs-webapp/1.0.0/
   3. Both of the above deployable units are needed for KOLE to function properly. 
2. Checking out the codebase from SVN - https://svn.kuali.org/repos/ole/tags/ole-1.0.0/

2. Running the software : 

1. Depending on how the software was obtained, there are certain steps to be followed and are explained below;
   1. Downloaded directly
      1. Copy and paste the war files in your local tomcat folder (goes under the tomcat home foder/webapps)
      2. Ensure the following folders are empty for a clean start
         1. logs folder
         2. work/Catalina/localhost
      3. Rename the war files from olefs-webapp-1.0.0.war to olefs.war and oledocstore-webapp-1.0.0.war to oledocstore.war respectively
      4. Create the following folder(s) in your user.home directly
         1. kuali/main/local/olefs-webapp
            1. Create a file named runonce.properties
         2. kuali/main/local/ole/oledocstore-webapp
            1. Create a file named runonce.properties

      5. runonce.properties file is used to indicate weather the database should be reset during application startup. Typically db needs to be set up for the very first time.

         runonce.properties

          project.db.reset=TRUE

   2. Customize application urls: By default, once the application is deployed, it can be accessed at http://localhost:8080/olefs and http://localhost:8080/oledocstore respectively. But for a local install the URL needs to be updated from localhost to an address that will be accessible publicly. 
      1. Create a file called common-config.xmlunder user.home/kuali/main/local. Contents of the file are as follows: 

          

         common-config.xml Expand source

         <!--
         
         Copyright 2004-2013 The Kuali Foundation
         Licensed under the Educational Community 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.opensource.org/licenses/ecl2.php
         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.
         -->
         <config>
         <!-- Generic URL's -->
         <param name="appserver.url">[Fill me]</param>
         <param name="application.url">${appserver.url}</param>
         <param name="keystore.file">[Fill me - Location of the keystore.file]</param>
         <!-- Server specific URL's -->
         <param name="ole.docstore.url.base">${application.url}/oledocstore</param>
         <param name="ole.fs.url.base">${application.url}/olefs</param>
         <!-- Database -->
         <param name="db.vendor">oracle</param>
         <param name="jdbc.username">[fill me]</param>
         <param name="oracle.dba.url">[fill me]</param>
         <param name="oracle.dba.username">[fill me]</param>
         <param name="oracle.dba.password">[fill me]</param>
         <param name="mysql.dba.url">[fill me]</param>
         <param name="mysql.dba.username">[fill me]</param>
         <param name="mysql.dba.password">[fill me]</param>
         
         <!-- Email -->
         <param name="mail.debug">false</param>
         <param name="mail.smtp.host">[fill me]</param>
         <param name="mail.smtp.port">465</param>
         <param name="mail.smtp.ssl.enable">true</param>
         <param name="mail.smtp.auth">true</param>
         <param name="mail.smtp.username">[fill me]</param>
         <param name="mail.smtp.password">[fill me]</param>
         </config>

   3. Verify application is up and running:
      1. Open up a web browser and verify the apps are up. Ex. http://localhost:8080/olefs and http://localhost:8080/oledocstore

      2. As part of application startup depending on weather db reset was required, the file runonce.properties under user.home/kuali/main/local/olefs-webapp and user.home/kuali/main/local/oledocstore-webapp should have the following entry;

         runonce.properties

         project.db.reset=COMPLETED

   4.