Okapi Installation Information
==============================

Requirements:
-------------

- Java 1.5 or later
- Web Browser
- Access to an Oracle,mySQL or MSSQL Database
- the JDBC driver according to your environment


Installation Steps:
-------------------

You should be up and running in 5-10 minutes ..

1.  Install the kit in any directory of your choice
    e.g. c:\program files\oekosoft\okapi

2.  Get your (test) license by registering on

http://www.oekosoft.ch/okapi/register.shtml or
      http://www.oekosoft.ch/okapi/register_e.shtml
    
    and save it as ..\config\okapi.license .

3.  Configure the batch skript bin\okapi.bat (on windows) or
bin/okapi.ksh (on unix) according your local environment.
  
    OKAPI_HOME must point to your installation directory.
  
    OKAPI_JDBCDRIVER must point to the jdbc driver according
    your database environment. For Oracle this is the ojdbc14.jar
    of your oracle installation. This file should be located
    in oracle\jdbc\lib .
    For mySQL and MSSQL you find according example lines. You
have to download the according driver from the providers site.
    In this case you have also to activate the according part in the
    file config/okapi.properties .
  
    OKAPI_CLASSPATH has to include the driver of your choice.
  
    Make sure, that the correct java version is called in
    the last line, by adding the according path, e.g.
    "c:\program files\java\java15\bin\java" .. You may test
    your local Java environment by 'java -version'.
  
4.  Add the installation bin directory to your PATH.

5.  Verify that you may start the program:

    okapi -V

    should produce the program information similar to    

    Oekosoft Okapi Version 1.3.0

    This is Okapi Version 1.3.0, build 2007.10.06

    Freeware license
      2 units
      version 1.3.*
      unlimited lifetime
 
    Copyright (c) 2006-2007 Oekosoft. All rights reserved.

    Complete documentation may be found under http://www.oekosoft.ch

6.  Study the okapi startup options:

    okapi -h
  
    Oekosoft Okapi Version 1.3.0

    Usage: okapi  [-options]

       options
         -h      this help
         -v      verbose mode
         -d      debug mode
         -t      trace mode
         -V      show version information

    e.g. okapi -v
  
7:  Start the okapi server in a shell window:

    okapi -v
    Oekosoft Okapi Version 1.3.0
    2007.10.07 10:04:18: Accepting requests on port 80 ..  

    If you have a local webserver runnning, you may need to
    configure another free port in the okapi.properties.
    There is no stop command for the okapi server. Just may
    just kill the process by ctrl-c or closing the shell window.
  
8:  Point your web browser to http://localhost/ or
    http://localhost:80/ .. and you should see the welcome page.

9.  Login to your database, take a look at the help page,
    and try to browse some tables.
   
10. Make you familiar with the okapi.properties file to tailor
    okapi to your environment:
  
    - fake missing relations
    - define default username and default databases
    - define default queries and filters
    - design a dedicated html homepage
    - ..

Oekosoft, www.oekosoft.ch, October 2010