How to install

Requirements

To run Boxroom you need the following:

• The Ruby programming language (1.8.4 or 1.8.5)
• Ruby on rails (version 1.2.x)
• MySQL or another RDBMS
• Ferret (the latest version)
• acts_as_ferret (the latest version)

If you want to use upload progress, you also need:

• Mongrel
• Mongrel Upload Progress plugin

Installation

Follow these steps to install Boxroom:

• Download the latest version of Boxroom
• Extract the downloaded zip. The application will be in a directory called boxroom.
• Create the Boxroom database like this:

  $ mysql -u root -p
  Enter password:
  Welcome to the MySQL monitor.  Commands end with ; or \g.
  Your MySQL connection id is 129 to server version: 4.1.15
  
  Type 'help;' or '\h' for help. Type '\c' to clear the buffer.
  
  mysql> create database boxroom;
  Query OK, 1 row affected (0.09 sec)
  
  mysql> exit
  Bye

• Tell the application how to connect to the database you just created by editing database.yml
• Although there's a database now; it doesn't have any tables yet. No problem: run the following command from the app's directory to load the database structure:

  $ rake db:migrate

• Open config/environment.rb with your favorite text editor. Replace the bogus settings with the settings you got from your ISP:

# ActionMailer config:
ActionMailer::Base.delivery_method = :smtp

ActionMailer::Base.server_settings = {
  :address => "your.smtp.server",
  :port => 25,
  :domain => "your.domain"
}

• If you want upload progress to work; open config/environment.rb and change

  USE_UPLOAD_PROGRESS = false

  to

  USE_UPLOAD_PROGRESS = true

• Finally, optionally, you might want to change the from address of the PasswordMailer. This setting can be found in app/models/password_mailer.rb
• In the app's directory; start the webserver like this:

  $ ruby script/server

  If you want to use upload progress you need to start the webserver like this:

  $ mongrel_rails start -S config/mongrel_upload_progress.conf

• Point your browser to http://localhost:3000/