Install plugins

Before running the commands shown on this page, you should load the Bitnami stack environment by executing the installdir/use_APPNAME script (Linux and MacOS) or by clicking the shortcut in the Start Menu under “Start -> Bitnami APPNAME Stack -> Application console” (Windows). On OS X VMs, the installation directory is /opt/bitnami and OS X VM users can click the “Open Terminal” button to run commands. Learn more about the Bitnami stack environment and about OS X VMs.

NOTE: The Approach A sections referred to below do not apply to Bitnami native installers. Users of Bitnami native installers should refer only to the Approach B sections.

Before installing a plugin, make sure that the plugin is compatible with your Redmine version. For plugins from the Redmine Plugin Directory. Select your Redmine version and check if the plugin is compatible or not with your version using the drop down menu located in the top right margin: “Show only plugins compatible with Redmine: version”.

  • Navigate to the Redmine installation directory. Depending on your installation type, execute the following commands:

    • Approach A (Bitnami installations using system packages):

        $ cd installdir/redmine
    • Approach B (Self-contained Bitnami installations):

        $ cd installdir/apps/redmine/htdocs/
  • Navigate to the plugins directory and get the .zip file or clone the plugin’s Git repository:

      $ cd plugins
  • If you have obtained a .zip file, uncompress it and then delete the original file. Remember to replace PLUGIN_NAME-x-y-z with the correct name and version of the plugin:

      $ unzip
      $ rm

    IMPORTANT: Before installing the plugin, check the installation notes in the plugin description or README. Some plugins need special installation requirements.

  • Navigate to the Redmine installation directory and install the plugin:

      $ cd -
      $ bundle install
      $ bundle exec rake redmine:plugins NAME=PLUGIN_NAME RAILS_ENV=production

    NOTE: It could display a warning message about the log production file. In that case, run the following commands:

    $ sudo chown :bitnami log/production.log
    $ sudo chmod g+w log/production.log
  • Restart Apache services:

      $ sudo installdir/ restart

Troubleshooting plugin installation

  • If you receive an error like this in Redmine 2.4.0-0 and newer:

    You are trying to install in deployment mode after changing your Gemfile. Run ‘bundle install’ elsewhere and add the updated Gemfile.lock to version control.

    Try adding the --no-deployment argument to the bundle install command as suggested in the error message.

Last modification August 31, 2021