How to install CAIRNS

Prerequisites

Ruby

http://www.ruby-lang.org/

Works with ruby 1.8.6, may work with earlier 1.8.x versions.

Ruby on Rails

http://www.rubyonrails.org/

Ruby on Rails 2.x required.

MySQL 5.x required.

Note: this document assumes MySQL has a user called 'root' with an empty password; feel free to substitute your own username/password as appropriate.

eXist

http://exist.sourceforge.net/

Works with eXist 1.2.3 (rev7866), probably works with any 1.x version.

Optional. If available and CAIRNS is configured to use it, eXist is used to store raw XML messages.

YUI

http://developer.yahoo.com/yui/

Works with YUI 2.5.1.

Third-party code included with the distribution

See '3RDPARTY' for a complete list.

Unpacking the distribution

Unpack the CAIRNS distribution.

Unpack the YUI distribution in CAIRNS/cairns/public

Configuration

MySQL settings

MySQL settings are in CAIRNS/cairns/config/database.yml

You may need/want to change 'username:' and 'password:' in the 'development:' section, or create a new user:

mysql> grant all privileges on cairns_development.* to 'cairns'@'localhost' identified by 'cassowary';

You may also need/want to change 'socket:' depending on your OS, so double-check that the MySQL socket is where this setting says it is.

Build MySQL database

% cd cairns; ruby create_db.rb | mysql -u root

eXist settings

eXist settings are in CAIRNS/cairns/config/environments/development.rb

CAIRNS_DATABASE_HOST should be the hostname of the eXist server. CAIRNS_DATABASE_PORT should be the port of the eXist server (eg. 8088).

Comment these lines out if you do not wish to use eXist.

Start CAIRNS

Start CAIRNS server

% ruby script/server

Point your browser at the start page

http://localhost:3000/