mailr/README.markdown

47 lines
1.4 KiB
Markdown
Raw Normal View History

2012-04-06 23:06:32 +02:00
[![Dependency Status](https://gemnasium.com/musashimm/mailr.png?travis)](https://gemnasium.com/musashimm/mailr)
2012-04-06 23:05:05 +02:00
2012-04-15 19:55:45 +02:00
**NOTE** The last stable version is 0.8.6. Now I try to moved code to Rails 3.2.3 and add Boostrap from Tweeter as default theme.
2012-03-24 18:09:31 +01:00
2011-06-24 23:48:08 +02:00
## Introduction
_MailR_ is a IMAP mail client based on _Ruby on Rails_ platform.
2011-06-24 23:48:08 +02:00
**NOTE** All path and filenames are based on _Rails.root_ directory.
## Requirements
2011-06-25 00:12:21 +02:00
2011-06-25 00:15:19 +02:00
In _Rails 3_ all dependencies should be defined in file _Gemfile_. All needed gems can be installed using bundler.
2011-06-24 23:48:08 +02:00
## Installation procedure
2011-06-24 23:48:08 +02:00
2011-06-25 00:12:21 +02:00
* Checkout the source code.
2011-07-29 20:05:47 +02:00
* Install all dependiences. Check if proper gems (sqlite3/mysql/postgresql) are defined in _Gemfile_ and installed. Use _bundler_ for that:
```shell
bundle install
```
* Check _config/defaults.yml_ for proper values.
2011-06-25 00:15:19 +02:00
* Prepare config/database.yml file (see _config/database.yml.example_).
2011-06-25 00:12:21 +02:00
* Migrate database (rake db:migrate)
2011-07-21 20:20:15 +02:00
* Start rails server if applicable
2011-07-29 20:05:47 +02:00
* Point your browser to application URL:
2011-07-21 20:20:15 +02:00
For local access: http://localhost:3000
For remote access: http://some_url/mailr
2011-07-29 20:05:47 +02:00
* Using browser do basic setup. If You make a mistake delete all data from DB using rake task:
```shell
rake db:clear_data
```
2011-07-21 20:20:15 +02:00
* Use it.
2011-08-24 19:20:13 +02:00
## Specific configuration
2011-08-24 19:20:13 +02:00
For themes: if server sends files with no content in production mode comment out
```ruby
config.action_dispatch.x_sendfile_header = "X-Sendfile"
```
in _config/environments/production.rb_ file.