Kwatee Installation Guide version 4.0.2

Introduction

Kwatee web application the is package as a standalone executable jar which does not require. an additional servlet container such as Tomcat or Jetty. Kwatee uses an internal H2 database by defaut but can be configured to use mysql or postgres and runs any operating system with Java 7 or newer. It has been tested on MacOS, Ubuntu and Windows but will run on any other flavor of linux or unix as well.

In either case, Kwatee self-deploys a proprietary and platform-specific agent (kwagent or kwagent.exe). At this time, there are agents for:

  • linux
  • Solaris x86
  • Solaris sparc
  • MacOS X
  • Windows
  • AIX

Pre-requisites

Kwatee is not very resource intensive so there is no need to dedicate a full server to it's operations.

Prerequisites
Javaversion 1.7 or newer
DatabaseKwatee uses an embedded H2 by default but you may configure it to use MySQL 5.1+ or PostgreSQL 8.4+.

Installation

1. Expand the archive

Expand the kwatee-distrib-4.0.2 archive. Well refer to the path of the expanded directory as KWATEE_HOME

2. Edit kwatee.properties

Edit KWATEE_HOME/kwatee.properties and customize the properties.

Kwatee properties
PropertyDescription
server.portThe port on which the kwatee web application will listen (default 8080)
kwatee.repository.paththe path to the repository directory (default: KWATEE_HOME/repository)
kwatee.jdbc.schemathe name of the kwatee database
kwatee.jdbc.userthe kwatee database user
kwatee.jdbc.passwordthe password of the database user
kwatee.jdbc.driverthe database driver
kwatee.jdbc.urlthe jdbc connection url whose format is specific to the jdbc driver
logging.pathdirectory where kwatee.log will be written (default: KWATEE_HOME/log)
FOR WINDOWS: if you choose to replace default paths by windows paths, you must make sure to use double backslashes, i.e. kwatee.repository.path=d:\\kwatee\\repository, or to replace them by forward slashes, i.e. kwatee.repository.path=d:/kwatee/repository.

Other databases

The default kwatee.properties are suitable for an installation on a file-based H2 database:

kwatee.jdbc.driver=org.h2.Driver
kwatee.jdbc.url=jdbc:h2:/${kwatee.repository.path}/db/${kwatee.jdbc.schema}

The properties below are suitable for an installation on a mysql database:

kwatee.jdbc.driver=com.mysql.jdbc.Driver
jdbc:mysql://localhost/${kwatee.jdbc.schema}

The properties below are suitable for an installation on a postgresql database:

kwatee.jdbc.driver=org.postgresql.Driver
kwatee.jdbc.url=jdbc:postgresql://localhost/${kwatee.jdbc.schema}

Optional SSL Configuration

If you want to configure SSL, you must first generate a key-pair. On linux:

keytool -genkey -alias kwatee -storetype PKCS12 -RSA -keysize 2048 -keystore keystore.p12 -validity 3650
Enter the password (<password>) and additional details for which you are prompted. After that, simply add the following properties in your kwatee.properties file:
server.ssl.key-store=keystore.p12
server.ssl.key-store-password=<password>
server.ssl.keyStoreType=PKCS12
server.ssl.keyAlias=kwatee

3. Launch Kwatee

on linux
KWATEE_HOME/kwatee.sh start
on windows
KWATEE_HOME\kwatee.bat start
and then point your browser to http://KwateeServer:8080/kwatee/

The web interface will guide you through the steps for creating the database schema which will require you to supply kwatee.jdbc.user and kwatee.jdbc.password that must have sufficient privileges for creating users and a database.

Once this final step is completed, you'll see Kwatee's login screen. The default administrator user is admin with password password.

Upgrading

The following procedure is recommended when upgrading to a new version of kwatee:

  1. Stop Kwatee with
    KWATEE_HOME/kwatee.sh stop
    or
    KWATEE_HOME\kwatee.bat stop
  2. Rename KWATEE_HOME to KWATEE_HOME.old
  3. Expand the kwatee-distrib package that you downloaded from kwatee.net to KWATEE_HOME
  4. Copy KWATEE_HOME.old/kwatee.properties to KWATEE_HOME/kwatee.properties
  5. If you kept your repository at KWATEE_HOME/repository then move it back from KWATEE_HOME.old to KWATEE_HOME
  6. Start Kwatee with
    KWATEE_HOME/kwatee.sh start
    or
    KWATEE_HOME\kwatee.bat start
  7. Point your browser to http://KwateeServer:8080/kwatee/