SourceForge.net Logo

Naiban: Installation

Naiban is a complete application, built on top of the Keel Meta-Framework which is in turn built on top of Avalon. Familiarity with either of these IOC frameworks should make installing & configuring Naiban much easier, but if you haven't had the opportunity to work with either, this step by step should put you on the right path.

Requirements

  1. Java 1.2+
  2. Maven

Download

Download the source distribution with runtime environment here: Naiban 0.1.0 distribution. Other files are available here. Unzip this archive into the directory where you would like Naiban installed.

Setup Environment

Create an environment variable NAIBAN_HOME pointing to your chosen installation directory (ex: NAIBAN_HOME=/home/jdoe/naiban ). Alternatively, hardcode this variable value in the startup script in (./bin/naiban.sh or ./bin/naiban.bat). Refer to the scripts themselves for more details.

Build

From NAIBAN_HOME, execute two maven tasks:

  • maven copy-dependencies - copies runtime libraries into NAIBAN_HOME/lib
  • maven jar - builds Naiban source and places jar into NAIBAN_HOME/lib
Naiban's dependencies are detailed in the maven project descriptor (project.xml). If maven is unable to download any of the required dependencies, you will need to obtain them manually. This is sometimes the case for libraries that can not be freely redistributed, and are not included in your JDK. Manually installed jars should be placed in the maven repository, and NAIBAN_HOME/lib.

Configure JDBC Support (Optional)

By default, Naiban uses the HSQL Database Engine, which will allow it to persist data locally (for its own use) in the ./db directory. If you would like to leverage another JDBC enabled RDMBS, you need to modify the ./config/jdbc-system.xconf file with the appropriate JDBC properties.

Launch Application

  • Launch Naiban with ./bin/naiban.sh