= Welcome to hieraki

== Dependencies

Ruby  1.8.2 (25.12.2004)
Rails 0.11+
Rubygems
Gems: syntax redcloth

== Database

You can find sql schemas for the different databases in the db folder.

Create the db and import the appropiate script before you continue with the installation. 

Example:

  mysqladmin create hieraki
  mysql hieraki < db/mysql.sql

After you created the database please verify the settings in config/database.yml

== Configuration

Go into the config dir and rename
  config.yml.example => config.yml
  database.yml.example => database.yml 
 
and update acordingly

== Web server

The simplest way to get hieraki running is use the rails shipped webrick server

  ./scripts/server -e production
  
This will launch a web server on port 3000. 
  
If you need a more sophisticated installation have a look at the rails resources[1] about the topic
Recommended and supported installation types 

 * Lighttpd/fastcgi
 * Apache/mod_fcgi with following configurations
  - as vhost
  - using a symlink from docroot to hieraki/public
  - using an alias to hieraki/public
 * Webrick

Make sure that you run hieraki in production mode(!)

[1]: http://wiki.rubyonrails.com/rails/show/ProductionEnvironments

== Troubleshooting

For questions please contact me in irc or by email at tobi [at] leetsoft.com. 
There is also a mailing list set up at: http://rubyforge.org/mailman/listinfo/hieraki-list