Plugin Install¶

Installing a plugin is a 5 step process.

1. Check for instructions in the plugin¶

Some plugins will have additional or different instructions on how to install them. If so, it is best to follow the instructions in the plugin to make sure it is installed correctly. These are typically kept in a README or INSTALL file.

If no additional instructions are found, you can follow these below.

2. Download the plugin¶

First download the plugin and extract it into the vendor/plugins directory. Make sure the name of the plugin matches the registration, typically chiliproject_NAME or redmine_NAME. Some plugins may require using a different name, so check their Readme file.

To check a plugin's registration name, open the init.rb file and look for a line of code that says Plugin.register :name. The name is what the directory should typically be called. In any case, check the plugins setup instructions.

3. Update the bundle¶

Plugins can add additional gem dependencies that need to be incorporated into your bundle. These additional gems might require some packages to be installed on your system (like non-ruby libraries or header files). Please consult the instructions of the plugin you like to install for additional information.

bundle install

Not every plugins requires additional gems, so it might be that this steps doesn't install additional gems

4. Update the database with the plugin migrations¶

Make a backup of your database before this step, just in case.

Next you will need to run the plugin's migrations so it can update the database. To do this, in the root of your ChiliProject installation run:

bundle exec rake db:migrate:plugins RAILS_ENV=production

Not every plugin using database migrations so if you don't see anything happen for the plugin you just installed, it's okay.

5. Restart ChiliProject¶

At this point you should restart the application servers for ChiliProject (mongrel, passenger). This will make sure the new plugin code is loaded correctly.