Feature #2435


Plugin API to check that a plugin is correctly installed

Added by Eric Davis over 14 years ago. Updated over 10 years ago.

Plugin API
Target version:
Start date:
Due date:
% Done:


Estimated time:
Wont fix


Both Redmine and Engine migrations follow a strict naming convention for plugins. Problem is, depending on the repository script/plugin install might install the plugin to an incorrect directory. This causes several issues including:

  • migrations get named after the wrong plugin
  • Settings get messed up and set incorrectly

I propose adding a check to Redmine::Plugin.register to make sure that the plugin name matches the installation directory.


# Required to be installed in vendor/plugins/budget_plugin
Redmine::Plugin.register :budget_plugin  

# Requires to be installed in vendor/plugins/embedded
Redmine::Plugin.register :embedded


Actions #1

Updated by Eric Davis over 14 years ago

  • Category set to Plugin API
  • Assignee set to Eric Davis

I can implement this, I just wanted to see if anyone had any better ideas other than throwing an error if the directory is incorrect.

Actions #2

Updated by Gerrit Kaiser over 14 years ago

sounds like a good idea. this hit me as well, and the current error message is not exactly clear about things. So a check would be appreciated!

Actions #3

Updated by Eric Davis about 13 years ago

  • Target version set to Unplanned backlogs
Actions #4

Updated by Holger Just about 13 years ago

I developed a patch. It is available from the feature branch on

Eric: Please check if this is enough or if I should extend it somehow.

Actions #5

Updated by Eric Davis almost 13 years ago

  • Assignee deleted (Eric Davis)

I am stepping down from working on Redmine. If someone else is interesting in working on this issue, feel free to reassign it to them.

Eric Davis

Actions #6

Updated by Jean-Baptiste Barth over 10 years ago

  • Status changed from New to Closed
  • Resolution set to Wont fix

Closing this, pretty old and some things have already been implemented since then (check on redmine version or plugin dependency for instance). Plus I don't think that enforcing a strict policy on directory name or place is a good idea (and I think Eric didn't either, see this post)

Actions #7

Updated by Jean-Baptiste Barth over 10 years ago

  • Target version deleted (Unplanned backlogs)

Also available in: Atom PDF