kat Online Bookmark Manager - Installation Guide

By Mitch Stuart
Copyright © 2005 FullSpan Software  -  Usage subject to license
Software Version: 1.0  -  Document Version: $Revision: 1.2 $, $Date: 2005/07/03 06:48:02 $

Introduction

This document is the Installation Guide for kat. See the Overview for general information and a list of other available kat documentation.

Installation Steps

1. Unpack the kat distribution file into a temporary working directory. We'll call this the KAT_WORK directory.
2. Create the database. This example is for the MySQL database, which is the only database tested for this release of kat. If you want to use a different database, please see the Development Guide for information on application changes that will be required.

   To create the MySQL database, use commands like this, substituting your own choice for database name, database user, and database password:

      mysql -p -u root
      CREATE DATABASE katdb;
      GRANT ALL ON katdb.* TO katdbusr@localhost IDENTIFIED BY 'katdbpwd';
      GRANT ALL ON katdb.* TO katdbusr@HOST IDENTIFIED BY 'katdbpwd';
      \q

   Note the two GRANT lines: the first is for localhost and the second is for the specific host name of the computer where the kat application will be running. Replace HOST with the name of the server (e.g., myserver).

3. Initialize the database. Change to the directory KAT_WORK/build/db and run initDb.sql like this:

      mysql -p -u katdbusr katdb
      \. initDb.sql
      \q

   Replace katdbusr and katdb with the values for the database you created in the previous step.
4. Create or select a directory where your kat configuration files will be stored. In many applications, this would be KAT_WORK/build/webapp/kat/WEB-INF or a subdirectory thereof. You can certainly use this directory if you wish. However, my preference is to keep configuration files outside of the application directory tree whenever possible, for example: /home/myname/prod/kat/conf. We'll call the configuation directory KAT_CONF.
5. Copy KAT_WORK/build/webapp/kat/WEB-INF/sample-config.properties to config.properties. Edit config.properties and set kat.configDir to the value of the KAT_CONF directory name.
6. Copy KAT_WORK/build/conf/sample-log4j.xml to KAT_CONF/log4j.xml and change this line:

      <param name="File" value="kat.log" />

   so that the filename is fully qualified, for example:

      <param name="File" value="/home/myname/prod/kat/kat.log" />

   You can also change other values such as the MaxFileSize, MaxBackupIndex and so on.
7. Copy KAT_WORK/build/conf/sample-hibernate.cfg.xml to KAT_CONF/hibernate.cfg.xml. Change these three lines:

      <property name="hibernate.connection.url">jdbc:mysql://DBSERVER/DBNAME?autoReconnect=true</property>
      <property name="hibernate.connection.username">DBUSER</property>
      <property name="hibernate.connection.password">DBPASSWORD</property>

   Replace the capitalized placeholders with your values for DBSERVER (e.g., localhost), DBNAME (e.g., katdb), DBUSER (e.g., katdbusr), and DBPASSWORD (e.g., katdbpwd).
8. Enable JavaMail support. JavaMail is used to send "fogotten password" emails, and any other email that may be generated by the kat application. kat has been tested with Tomcat versions 4.1.30 and 5.0.28. Tomcat4 includes the JavaMail API (mail.jar and activation.jar) as part of the server libraries, whereas Tomcat5 does not. To enable JavaMail support:
   • Determine if your servlet container bundles the JavaMail API. If you are using Tomcat4 or another servlet container that includes mail.jar and activation.jar, no action is needed.
   • If not, go into KAT_WORK/build/webapp/kat/WEB-INF/lib and rename mail.jar-aux to mail.jar and activation.jar-aux to activation.jar.
9. Install the kat webapp in your servlet container. The kat webapp consists of the directory KAT_WORK/build/webapp/kat, including all files and subdirectories. Usually (for example, with Tomcat), you just copy KAT_WORK/build/webapp/kat to your servlet container webapps directory. It will detect the new directory and start the webapp. Your procedure may vary depending on your servlet container and your settings.
10. Login using the default admin account:
    • Login ID: admin
    • Password: changeme
    and change the password for the admin user. It is important to do this right away (this is discussed in more detail below).
11. While logged in as admin, go into the App Settings screen and set up the email and other settings. See the Administration Guide for more information on App Settings.

Default Administrator Account

In between the time that you install the kat application and change the admin password, it would be possible for another user to login using the documented default admin Login ID and password. This is why it is important for you to change the password immediately upon installation.

To enhance security, you can change the default admin Login ID in the .sql file before running it.

For maximum security, you can change the default password as well. The password is stored using a hash algorithm. For the default password, the values are:

• Password plain text: changeme
• PasswordSaltString: lk6Q4D5u9SQ=
• PasswordHashString: socnfOrlc6lsiP2yrsO43TNLnLE=