-
Notifications
You must be signed in to change notification settings - Fork 406
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":mailto:sales@teambox.com.
Otherwise if you have problems that our open source community might help with, please refer to the "teambox community project":http://teambox.com/community.
h2. 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":http://git-scm.com/, so you can download the source. Check with @git --version@
- "Ruby":http://www.ruby-lang.org 1.8.7. You may have it already, check @ruby -v@ to make sure.
- "RubyGems":http://rubygems.org, extract it and run @sudo ruby setup.rb@. Check with @gem -v@
- "Bundler":http://gembundler.com/. Install with @gem install bundler -v '~> 1.0.0.rc'@, 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":http://mxcl.github.com/homebrew/: @brew install imagemagick@. Check with @convert -version@
h2. Getting the source and dependencies
First, download the code:
bc.. git clone git://github.com/teambox/teambox.git cd teambox
p. Now choose the branch you will be running on.
- master is the stable branch, best for production environments.
- dev is the development branch, always on the cutting edge with features.
In this case, we will use master:
bc. git checkout master
p. Bootstrap necessary ruby libraries with Bundler:
bc. bundle install
h2. 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.
bc.. cp config/database.example.yml config/database.yml
h2. Configure Teambox:
Edit "config/teambox.yml" to set your domain name and email information. see Configure-teambox.yml for more information.
A good service for outgoing email is Sendgrid. You can also use GMail.
bc.. host: smtp.sendgrid.net username: your@username.com password: your_password auth: plain port: 25 enable_starttls_auto: false
h2. 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:
bc. bundle exec rake db:create db:schema:load RAILS_ENV=development
h2. Test your app if working
Inside the directory where you installed Teambox, run the server:
bc. rails 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.
h2. Bonus: Example data
If you want to have an example database with users, conversations and tasks to play with, run this after your installation is complete:
bc. bundle exec rake db:seed
It will help you for development.