How to: Generators

The basic installation of bigbluebutton_rails require you to use the following generator:

rails generate bigbluebutton_rails:install

This generator will create a migration file, a locale file and some additional resources. Take a look at the migration to see how the models used by bigbluebutton_rails look like.

The additional files created are basically the JQuery javascript library, a stylesheet and some images. These resources are only used in the views, so you might choose not to use them. To do that, simply remove the files and edit the views (after generating them, see below).

To see all the options that the generator provides, run:

rails generate bigbluebutton_rails:install --help

All models, controllers and views used are embedded in the gem, but you can replace or extend them if you need to. There is one generator to help you with that:

rails generate bigbluebutton_rails:views

It copies all bigbluebutton_rails views into your application, so you can customize them as you wish.

To change how controllers or models work, you can create classes that extend them. See How to: Inherit controllers.

Migrating from previous versions

For version >= 0.0.5, bigbluebutton_rails provides a generator to create a database migration to update the gem version.

When you run:

rails generate bigbluebutton_rails:install 0.0.5 --migration-only

A migration file will be generated to migrate bigbluebutton_rails from 0.0.4 to 0.0.5.