mailr/README.markdown
Wojciech Todryk 1ea0781ddb README fixed
2011-06-25 00:05:54 +02:00

46 lines
1.2 KiB
Markdown

## Introduction
_Mailr_ is a IMAP mail client based on _Ruby on Rails_ platform.
## Installation guide
**NOTE** All path and filenames are based on _Rails.root_ directory.
### Requirements
In _Rails 3_ all dependencies should be defined in file _<Rails.root>.Gemfile_. All needed gems can be installed using bundler.
### Installation procedure
1. Checkout the source code.
2. 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:
```ruby
module CDF
LOCALCONFIG = {
:imap_server => 'your.imap.server'
}
end
```
3. Configure SMTP settings
```ruby
# initializers/smtp_settings.rb
ActionMailer::Base.smtp_settings = {
:address => "mail.example.com.py",
:port => 26,
:authentication => :plain,
:enable_starttls_auto => true,
:user_name => "emilio@example.com.py",
:password => "yourpass"
}
```
4. Prepare config/database.yml file (see config/database.yml.example).
Check if proper gems (sqlite3/mysql/postgresql) are defined in _Gemfile_ and installed.
5. Migrate database (rake db:migrate)
6. Use it.