Installing locally

If you want to run your own server with Teambox, some knowledge of Ruby on Rails and UNIX is helpful.

This document explains how to get Teambox running in your local machine. The guide is intended for Linux, Mac and Unix-like systems.

Need help? Email us to do it for you as a professional service.

Otherwise if you have problems that our open source community might help with, please refer to our mailing list.

Pre-requisites

You’ll need a UNIX-based machine, like Linux or Mac. We can’t offer support for Windows.

Make sure you have the following installed:

• Git, so you can download the source. Check with git --version
• Ruby 1.8.7. You may have it already, check ruby -v to make sure.
• RubyGems, extract it and run sudo ruby setup.rb. Check with gem -v
• Bundler. Install with gem install bundler -v '~> 0.9.12', check with bundle -v
• MySQL, the database we are using. Check with mysql --version. (You can also try any other ActiveRecord-supported database, like PostgreSQL.)
• ImageMagick so you can resize images. On Mac OS X, easiest way is with Homebrew: brew install imagemagick. Check with convert -version

Getting the source and dependencies

First, download the code:

git clone git://github.com/teambox/teambox.git

Bootstrap necessary ruby libraries with Bundler:

bundle install

Copy example configuration files

Copy the example configuration files to their proper names. If you move them instead of copy them, you’ll run into problems when you update Teambox in the future.

cp config/database.example.yml config/database.yml

Configure Teambox:

Edit “config/teambox.yml” to set your domain name and email information.

A good service for outgoing email is Sendgrid. You can also use GMail.

host: smtp.sendgrid.net
username: your@username.com
password: your_password
auth: plain
port: 25
enable_starttls_auto: false

Configure the database

Edit “config/database.yml” and set your database user and password under environments you’re going to use.

In the following steps, substitute “development” with “production” if you’re setting up a production environment on a remote server.

Bootstrap the database:

rake db:create db:schema:load RAILS_ENV=development

Test your app if working

Inside the directory where you installed Teambox, run the server:

script/server -e development

Now browse to http://localhost:3000 (substitute “localhost” for your domain name if you’re on a remote server), you should see a server with your Teambox copy.