awsredmine

Install plugins

NOTE: We are in the process of modifying the file structure and configuration for many Bitnami stacks. On account of these changes, the file paths stated in this guide may change depending on whether your Bitnami stack uses native Linux system packages (Approach A), or if it is a self-contained installation (Approach B). To identify your Bitnami installation type and what approach to follow, run the command below:

 $ test ! -f "/opt/bitnami/common/bin/openssl" && echo "Approach A: Using system packages." || echo "Approach B: Self-contained installation."

The output of the command indicates which approach (A or B) is used by the installation, and will allow you to identify the paths, configuration and commands to use in this guide. Refer to the FAQ for more information on these changes.

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 /opt/bitnami/redmine
      
    • Approach B (Self-contained Bitnami installations):

        $ cd /opt/bitnami/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 PLUGIN_NAME-x-y-z.zip
      $ rm PLUGIN_NAME-x-y-z.zip
    

    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 /opt/bitnami/ctlscript.sh 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