Rails 1.1

1. Create your Rails application.

rails myapp

2. Enter the your app directory

cd myapp

3. Install Engines plugin

svn co http://svn.rails-engines.org/engines/tags/rel_1.1.2 vendor/plugins/engines

4. Install Mailr engine

svn co http://svn.littlegreen.org/mailr/branches/engine vendor/plugins/mailr

5. If you need to override some of the default constants used in the application take a look at vendor/plugins/mailr/lib/mailr.rb. Then edit config/environment.rb and add the changes you need and the Mailr Engine start statement:

module CDF

   LOCALCONFIG = {
     :imap_server => 'your.imap.server'
   }            
   end
   
   Engines.start :mailr

6. Create empty database. Edit database configuration in config/database.yml. Create Mailr schema with:

rake db:migrate:engines

7. Start your web server and login in the application with your IMAP user and password, pointing your browser to http://your.app.server/login

Rails 1.0

1. Create your Rails application.

rails myapp

2. Delete some files

cd myapp
rm app/controllers/application.rb
rm app/helpers/application_helper.rb 
rm public/index.html

3. Install Engines plugin

svn co http://svn.rails-engines.org/engines/tags/rel_1.0.6 vendor/plugins/engines

4. Install Mailr engine

svn co http://svn.littlegreen.org/mailr/branches/engine vendor/plugins/mailr -r 170

5. Copy all of the files from ./config_stubs into your /config directory

cp vendor/plugins/mailr/config_stubs/* config/

6. Create empty database. Edit database configuration in config/database.yml. Create Mailr schema with:

rake engine_migrate

or

rake engine_migrate RAILS_ENV='production'

7. If you need to override some of the default constants used in the application take a look at config/default_site.rb. Then create config/site.rb that contains only the keys which you want to override. Example content of config/site.rb is:

module CDF

   LOCALCONFIG = {
     :imap_server => 'your.imap.server'
   }            
   end

8. Start your web server and login in the application with your IMAP user and password.