Skip to content
koyach edited this page Feb 2, 2012 · 20 revisions

Install

Prerequisites

Rollcall is a Rails 3.x application. You don't need to know anything about Ruby or Rails to install and run it, but you will need a basic Ruby environment. Check if ruby and gem commands already work on your command line. If so, you're probably good to go. Otherwise follow instructions on the Ruby Language site.

Quick Install

The following set of commands should get you up and running (without XMPP integration):

gem install bundler
cd <where you want rollcall installed>
git clone git://github.com/educoder/rollcall.git
cd rollcall
bundle install --without development

nano config/database.yml
# Change the production settings near the bottom of the file to choose your database.
# Afterwards create the database if necessary (e.g. `mysqladmin -u root create rollcall`).

RAILS_ENV=production
rake db:migrate

rails -v
# make sure you're running Rails 3.0.7 or higher!

rails s -e production

Rollcall should now be running at [http://localhost:3000].

The commonly used RESTful URLS are:

Most URLs also responds to .xml and .json extensions. For example:

XMPP Server Integration

Rollcall can be used to manage accounts in one of the following XMPP servers:

To enable integration for your XMPP server, uncomment the correct module in the Gemspec file and configure things under config/environments/production.rb (or development.rb if you're running in development mode). Examples for each supported XMPP server are included at the bottom of the stock production.rb config file.

REST API

Client Examples

Writing Plugins

See this Gist for now: https://gist.github.com/1251821

Database Schema

Clone this wiki locally