Browse files

Added info about mail settings

  • Loading branch information...
1 parent cc0fa01 commit f7c54facb819b3bf0f51022e0ffd8de55a3b1164 @mischa78 mischa78 committed Jun 20, 2011
Showing with 24 additions and 2 deletions.
  1. +24 −2 README.md
View
26 README.md
@@ -18,10 +18,10 @@ http://rubyforge.org/tracker/?atid=6303&group_id=1611&func=browse
Requirements
------------
-The minimum requirements for running Boxroom are:
+The requirements for running Boxroom are:
* Ruby 1.8.7 or Ruby 1.9.2
- * Rails 3.0 or bigger
+ * Rails 3.0.x
* A database (e.g. MySQL or SQLite)
@@ -37,6 +37,28 @@ Follow the these steps:
6. Enjoy!
+Mail settings
+-------------
+Boxroom sends email when users want to reset their password or when they share files.
+For this to work, you have op to open `config/environments/production.rb`, uncomment
+the following lines and fill in the correct settings of your mail server:
+
+ # config.action_mailer.default_url_options = { :host => 'localhost:3000' }
+ # config.action_mailer.delivery_method = :smtp
+ # config.action_mailer.smtp_settings = {
+ # :address => 'mailhost',
+ # :port => 587,
+ # :user_name => 'user_name',
+ # :password => 'password',
+ # :authentication => 'plain'
+ # }
+
+You also have to choose a from address for the emails that will be sent. You can do
+this by uncommenting and adjusting the following line:
+
+ # ActionMailer::Base.default :from => 'Boxroom <yourname@yourdomain.com>'
+
+
Languages
---------
Thanks to [Rob Halff](https://github.com/rhalff) and [Marcus Ilgner](https://github.com/milgner)

0 comments on commit f7c54fa

Please sign in to comment.