Welcome to Boxroom

Boxroom is a Rails 3.1 application that aims to be a simple interface for sharing files in a web browser. To make this possible the application lets users create folders and upload and download files. For admins it is possible to create users, groups and the CRU/D rights these groups have on folders.

Website:
http://boxroom.rubyforge.org/

Bug reports and feature requests:
https://github.com/mischa78/boxroom/issues/new

Requirements

The requirements for running Boxroom are:

Ruby 1.8.7 or Ruby 1.9.2
Rails 3.1.1
A database (e.g. MySQL or SQLite)

Installation

Follow the these steps:

Extract boxroom.zip and cd to the newly created folder
Update your bundle: $ bundle
Create a database and schema: $ rake db:migrate
Start the server: $ rails server
Point your browser to http://localhost:3000/
Enjoy!

Mail settings

Boxroom sends email when users want to reset their password or when they share files. For this to work, depending on your environment, you have op to open config/environments/development.rb or config/environments/production.rb, uncomment the following lines and fill in the correct settings of your mail server:

# config.action_mailer.delivery_method = :smtp
# config.action_mailer.smtp_settings = {
#   :address => 'mailhost',
#   :port => 587,
#   :user_name => 'user_name',
#   :password => 'password',
#   :authentication => 'plain'
# }

In order for Boxroom to send a user to the correct URL for either downloading a shared file or for resetting passwords, you have to uncomment and update the following:

# config.action_mailer.default_url_options = { :host => 'localhost:3000' }

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, Marcus Ilgner and Jessica Marcon Boxroom is now available in Dutch, German and Italian.

English is the default. To change the language, open config/application.rb and change the following line:

config.i18n.default_locale = :en

to:

config.i18n.default_locale = :nl # Dutch
config.i18n.default_locale = :de # German
config.i18n.default_locale = :it # Italian

It would be great to have many more languages. I am waiting for your pull requests! ;-)

Downloaded files are empty

If you encounter an issue with Boxroom where downloaded files are always empty, it may help to uncomment the following line in config/environments/production.rb:

# config.action_dispatch.x_sendfile_header = 'X-Accel-Redirect'

License

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.