Skip to content
This repository has been archived by the owner on Jan 30, 2018. It is now read-only.

Installing locally

Jump to bottom
T-Moe edited this page Aug 9, 2010 · 22 revisions

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

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? Let us do it for you as a professional service.
If you have any problems, please refer to our mailing list.

Pre-requisites

You’ll need a UNIX-based machine, like Linux or Mac. Windows is not recommended.

  • Install Git so you can download the source. Instructions.
  • Install Ruby 1.8.7. You probably have it already, type ruby -v to make sure.
  • Download RubyGems, extract it and run [sudo] ruby setup.rb.
  • Install Bundler gem with [sudo] gem install bundler -v '~> 0.9.12'.
  • Install MySQL, the database we will be using.
  • Install ImageMagick so you can resize images.

Getting the source and dependencies

First, download the code:

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

Now, let’s install the missing gems for Ruby:

bundle install

We will now create a database and migrate it so it has the tables we need:

rake db:create:all
rake db:migrate

Configuring

We’re almost done! You must now edit config/teambox.yml to point to your own server and enable outgoing email.

Replace the needed values for your own domain name.
Replace the contact and support addresses.
Enter your email settings for outgoing mail.
Optional: Configure incoming email.

You’re done!

Let’s start the server so you can start using it!

Run the server with:

./script/server

Now point your browser to http://localhost:3000 and start using Teambox!

Got it running? Join our mailing list to keep up to date, and help other solve their problems!

Note: If you are using Teambox without an outgoing email server, you can see the sent emails in the server console.

Running as a daemon

Although it is recommended to use a webserver like Apache or Nginx (with “Passenger” module), it is possible to run the included Webrick server in daemon mode. Simple alter the command above to the following:

./script/server -d
Clone this wiki locally