Forum: 
Support
Tags: 
redmine
plugins

Installing Redmine plugins onto the Turnkey Redmine appliance

Julian Charles Ball's picture
Julian Charles Ball - Mon, 2011/01/17 - 15:05

I'm looking to download and experiment with the Turnkey Redmine appliance.  Can someone please advise whether I'd be able to install Redmine plugins onto the device and if so how?  All help gratefully received!

- Julian 

Steve's picture

Steve - Mon, 2011/01/24 - 12:50

Sure - it works fine to install plug-in's - other than check compatibility first

Nav to your railsapp/vendor/plugins and download the plugin then rack the db to update

I would advise backing up the db before each plugin install

Download straight from GitHub worked for us best - i.e.

git clone git://github.com/user_name/name_of_the_plugin.git

then - if needed 

 

rake db:migrate:plugins RAILS_ENV=production
Scott's picture

Scott - Sun, 2012/09/30 - 19:48

How do you execute rake from the Amazon Webadmin Command Shell?  It keeps saying rake does not exist and it does not allow you to cd to any particular directory.

Trying to instakll this plugin:
http://redminecrm.com/projects/contacts-plugin/wiki
http://redminecrm.com/projects/contacts-plugin/wiki/Installation
> gem install -v=2.0.6 acts-as-taggable-on
Successfully installed acts-as-taggable-on-2.0.6
1 gem installed
Installing ri documentation for acts-as-taggable-on-2.0.6...
Installing RDoc documentation for acts-as-taggable-on-2.0.6...
> gem install -v=0.695 vpim
Successfully installed vpim-0.695
1 gem installed
Installing ri documentation for vpim-0.695...
Installing RDoc documentation for vpim-0.695...
> rake db:migrate_plugins RAILS_ENV=production
rake aborted!
No Rakefile found (looking for: rakefile, Rakefile, rakefile.rb, Rakefile.rb)

(See full trace by running task with --trace)

Kirill's picture

Kirill - Wed, 2012/10/24 - 10:34

What plugin version are you trying to install? And what is your redmine version?

You should run rake command from redmine app directory or use full path like this :

 for redmine < 2

 rake -f /var/data/redmine/Rakefile db:migrate_plugins RAILS_ENV=production

 for redmine 2+ 

 rake -f /var/data/redmine/Rakefile redmine:plugins RAILS_ENV=production

Gavin's picture

Gavin - Tue, 2016/02/23 - 14:10

Hi

 

I have just installed a vanilla version of the Turnkey Redmine iso. It all starts up fine and works grreat.,

Now I'm interested in adding a plugin (a back log plugin)

I'm following these instructions

 

http://www.redminebacklogs.net/en/installation.html#

 

 

When I follow them it states that I need to run some commands in the plugin directory. Any idea where I can find this? I don't seem to have a /var/lib/Redmine directory or  railsapp/vendor/plugins or var/data/redmine

Please point me in the right direction of where to install it.

 

Thanks

 

gavin

Jeremy Davis's picture

Jeremy Davis - Thu, 2016/02/25 - 07:30
The find command is very handy in these situations! :)

To find the three directories you're looking for I would try something like this: 

find / -type d -iname redmine # iname means it's case insensative
find / -type d -name railsapp
If they output too much, you can use grep to narrow it down: 
find / -type d -iname redmine | grep data
Gavin's picture

Gavin - Thu, 2016/02/25 - 11:01

Thanks

 

But it looks like I don't have railsapp as nothing was output for that command.??

 

 

root@redmine 2.1.0/redmine_backlogs# find / -type d -iname redmine
/var/www/redmine
/var/www/redmine/test/unit/lib/redmine
/var/www/redmine/test/integration/lib/redmine
/var/www/redmine/lib/redmine
/var/log/redmine
root@redmine 2.1.0/redmine_backlogs# find / -type d -name railsapp
root@redmine 2.1.0/redmine_backlogs#

 

Rafael de Almeida's picture

Rafael de Almeida - Sat, 2016/03/19 - 02:11

hi, I need a step by step to install plugins in redmine. for example this plugin: http://www.redminebacklogs.net/en/installation.html. How do I install?

 

Thanks

Gavin's picture

Gavin - Thu, 2016/02/25 - 11:06

I assume this is my plugin directory?

 

/var/lib/gems/2.1.0/extensions/x86_64-linux/2.1.0

 

 

 

 

Gavin's picture

Gavin - Thu, 2016/02/25 - 11:12

OK forget that... I just found it 

 

/var/www/redmine/plugins

 

 

Doh!

 

Thanks everyone for your help!

 

Gavin's picture

Gavin - Thu, 2016/02/25 - 12:31

OK I am back again.... have got much further with the install of the redmine backlog plugin.

 

When executing the command

 

 bundle exec rake redmine:backlogs:install

 

 

I get the following error

 

 

(in /var/www/redmine)
rake aborted!
NameError: uninitialized constant ActionDispatch::XmlParamsParser
/var/www/redmine/config/application.rb:52:in `<class:Application>'
/var/www/redmine/config/application.rb:8:in `<module:RedmineApp>'
/var/www/redmine/config/application.rb:7:in `<top (required)>'
/var/www/redmine/Rakefile:5:in `require'
/var/www/redmine/Rakefile:5:in `<top (required)>'
(See full trace by running task with --trace)

 

 

 

Any ideas?

 

Thanks Gavin

Jeremy Davis's picture

Jeremy Davis - Sat, 2016/03/05 - 03:37
TBH I'm not that familiar with ruby stuff, but a quick google suggests that this issue may be because the plugin is not compatible with the current TurnKIey environment.

It might be worth checking with the plugin provider. Do they have some sort of support? Please post back if you get any further with this (even if it's not solved). I'll try to help as much as I can...

Actually if you can post the exact steps you've taken so far so I could try to reproduce it when I get a chance. Then I can see if there's something wrong with TurnKey; or it's just an incompatibility.

Gavin's picture

Gavin - Fri, 2016/03/18 - 02:31

Hi Sorry for my late reply. I also got side tracked.

The steps I followed were from here

http://www.redminebacklogs.net/en/installation.html#

Then I followed method 1

Method #1

NOTE: This first method requires some knowledge of git. For more information on how to use it, please visit the git homepage.

First, make sure that you’re inside the `plugins` directory of your Redmine instance. Now, clone the source from Github by executing the following command:

git clone git://github.com/backlogs/redmine_backlogs.git

This will create a directory named `redmine_backlogs` which is exactly what we need.

IMPORTANT: Don’t rename the `redmine_backlogs` directory!

Now you need to select the version you want to use. First, go inside the `redmine_backlogs` directory by executing the following:

cd redmine_backlogs

Then, take a look at the available versions that have been tagged in the repo:

git tag

This will display the versions in alphabetical order. Choose the latest version (recommended), or whichever you prefer by running the following command:

git checkout vX.Y.Z

NOTE: Replace ‘X.Y.Z’ with the version of your choice.

That’s it for Method #1. If you want to try out some of the experimental features, feel free to poke around by checking out the master branch or any other available branches. See the section titled Optional: Getting the latest code below for information on how to do that.

After this I then did

Then I ran 

bundle exec rake db:migrate

Which is where I get the error.

Hope this helps

Regards

Gavin

Gavin's picture

Gavin - Fri, 2016/03/18 - 02:42

I had removed the capybara entry from the Genfile as suggested. 

But I then received the following error

root@redmine www/redmine# vi Gemfile
root@redmine www/redmine# bundle exec rake db:migrate
Could not find gem 'capybara (~> 1.1.0)' in any of the gem sources listed in your Gemfile or available on this machine.
Run `bundle install` to install missing gems.
root@redmine www/redmine# gem install capybara
Successfully installed capybara-2.6.2
Parsing documentation for capybara-2.6.2
Done installing documentation for capybara after 4 seconds
1 gem installed
root@redmine www/redmine# bundle exec rake db:migrate
Could not find gem 'capybara (~> 1.1.0)' in any of the gem sources listed in your Gemfile or available on this machine.
Run `bundle install` to install missing gems.
root@redmine www/redmine# bundle install
Don't run Bundler as root. Bundler can ask for sudo if it is needed, and installing your bundle as root will break this
application for all non-root users on this machine.
Warning: this Gemfile contains multiple primary sources. Using `source` more than once without a block is a security risk, and may result in installing unexpected gems. To resolve this warning, use a block to indicate which gems should come from the secondary source. To upgrade this warning to an error, run `bundle config disable_multisource true`.
Fetching gem metadata from https://rubygems.org/...........
Fetching version metadata from https://rubygems.org/...
Fetching dependency metadata from https://rubygems.org/..
Resolving dependencies......
Using rake 10.4.2
Using i18n 0.7.0
Using json 1.8.3
Using minitest 5.8.2
Using thread_safe 0.3.5
Using builder 3.2.2
Using erubis 2.7.0
Using mini_portile 0.6.2
Using rack 1.6.4
Using mime-types 2.6.2
Using arel 6.0.3
Using bundler 1.11.2
Using coderay 1.1.0
Using daemons 1.2.3
Installing eventmachine 1.2.0.1 with native extensions
Installing holidays 1.0.8
Using htmlentities 4.3.1
Using icalendar 2.3.0
Using thor 0.19.1
Using mysql2 0.3.20
Using net-ldap 0.3.1
Using open-uri-cached 0.0.5
Using pdf-core 0.6.1
Using ttfunk 1.4.0
Using ruby-openid 2.3.0
Using redcarpet 3.1.2
Using request_store 1.0.5
Using rmagick 2.13.4
Using tzinfo 1.2.2
Using nokogiri 1.6.6.3
Using rack-test 0.6.3
Using sprockets 3.4.0
Using mail 2.6.3
Using thin 1.6.4
Using rbpdf 1.18.7
Installing prawn 2.1.0
Using rack-openid 1.4.2
Using activesupport 4.2.1
Using loofah 2.0.3
Using rails-deprecated_sanitizer 1.0.3
Using globalid 0.3.6
Using activemodel 4.2.1
Using rails-html-sanitizer 1.0.2
Using rails-dom-testing 1.0.7
Using activejob 4.2.1
Using activerecord 4.2.1
Using protected_attributes 1.1.3
Using actionview 4.2.1
Using actionpack 4.2.1
Using actionmailer 4.2.1
Using actionpack-action_caching 1.1.1
Using actionpack-xml_parser 1.0.2
Using railties 4.2.1
Using sprockets-rails 2.3.3
Using jquery-rails 3.1.4
Using rails 4.2.1
Bundle complete! 50 Gemfile dependencies, 56 gems now installed.
Gems in the groups test and development were not installed.
Use `bundle show [gemname]` to see where a bundled gem is installed.
root@redmine www/redmine# bundle exec rake db:migrate
rake aborted!
ArgumentError: The scope body needs to be callable.
/var/lib/gems/2.1.0/gems/activerecord-4.2.1/lib/active_record/scoping/named.rb:143:in `scope'
/var/www/redmine/plugins/redmine_backlogs/app/models/rb_release.rb:174:in `<class:RbRelease>'
/var/www/redmine/plugins/redmine_backlogs/app/models/rb_release.rb:156:in `<top (required)>'
/var/lib/gems/2.1.0/gems/activesupport-4.2.1/lib/active_support/dependencies.rb:274:in `require'
/var/lib/gems/2.1.0/gems/activesupport-4.2.1/lib/active_support/dependencies.rb:274:in `block in require'
/var/lib/gems/2.1.0/gems/activesupport-4.2.1/lib/active_support/dependencies.rb:240:in `load_dependency'
/var/lib/gems/2.1.0/gems/activesupport-4.2.1/lib/active_support/dependencies.rb:274:in `require'
/var/lib/gems/2.1.0/gems/activesupport-4.2.1/lib/active_support/dependencies.rb:360:in `require_or_load'
/var/lib/gems/2.1.0/gems/activesupport-4.2.1/lib/active_support/dependencies.rb:494:in `load_missing_constant'
/var/lib/gems/2.1.0/gems/activesupport-4.2.1/lib/active_support/dependencies.rb:184:in `const_missing'
/var/lib/gems/2.1.0/gems/activesupport-4.2.1/lib/active_support/dependencies.rb:526:in `load_missing_constant'
/var/lib/gems/2.1.0/gems/activesupport-4.2.1/lib/active_support/dependencies.rb:184:in `const_missing'
/var/lib/gems/2.1.0/gems/activesupport-4.2.1/lib/active_support/dependencies.rb:526:in `load_missing_constant'<
/var/lib/gems/2.1.0/gems/activesupport-4.2.1/lib/active_support/dependencies.rb:184:in `const_missing'
/var/www/redmine/plugins/redmine_backlogs/lib/backlogs_issue_query_patch.rb:31:in `block in included'
/var/www/redmine/plugins/redmine_backlogs/lib/backlogs_issue_query_patch.rb:25:in `class_eval'
/var/www/redmine/plugins/redmine_backlogs/lib/backlogs_issue_query_patch.rb:25:in `included'
/var/www/redmine/plugins/redmine_backlogs/lib/backlogs_issue_query_patch.rb:145:in `include'
/var/www/redmine/plugins/redmine_backlogs/lib/backlogs_issue_query_patch.rb:145:in `<top (required)>'
/var/lib/gems/2.1.0/gems/activesupport-4.2.1/lib/active_support/dependencies.rb:274:in `require'
/var/lib/gems/2.1.0/gems/activesupport-4.2.1/lib/active_support/dependencies.rb:274:in `block in require'
/var/lib/gems/2.1.0/gems/activesupport-4.2.1/lib/active_support/dependencies.rb:240:in `load_dependency'
/var/lib/gems/2.1.0/gems/activesupport-4.2.1/lib/active_support/dependencies.rb:274:in `require'
/var/lib/gems/2.1.0/gems/activesupport-4.2.1/lib/active_support/dependencies.rb:360:in `require_or_load'
/var/lib/gems/2.1.0/gems/activesupport-4.2.1/lib/active_support/dependencies.rb:317:in `depend_on'
/var/lib/gems/2.1.0/gems/activesupport-4.2.1/lib/active_support/dependencies.rb:233:in `require_dependency'
/var/www/redmine/plugins/redmine_backlogs/init.rb:27:in `block in <top (required)>'
/var/lib/gems/2.1.0/gems/activesupport-4.2.1/lib/active_support/callbacks.rb:446:in `instance_exec'
/var/lib/gems/2.1.0/gems/activesupport-4.2.1/lib/active_support/callbacks.rb:446:in `block in make_lambda'
/var/lib/gems/2.1.0/gems/activesupport-4.2.1/lib/active_support/callbacks.rb:192:in `call'
/var/lib/gems/2.1.0/gems/activesupport-4.2.1/lib/active_support/callbacks.rb:192:in `block in simple'
/var/lib/gems/2.1.0/gems/activesupport-4.2.1/lib/active_support/callbacks.rb:504:in `call'
/var/lib/gems/2.1.0/gems/activesupport-4.2.1/lib/active_support/callbacks.rb:504:in `block in call'
/var/lib/gems/2.1.0/gems/activesupport-4.2.1/lib/active_support/callbacks.rb:504:in `each'
/var/lib/gems/2.1.0/gems/activesupport-4.2.1/lib/active_support/callbacks.rb:504:in `call'
/var/lib/gems/2.1.0/gems/activesupport-4.2.1/lib/active_support/callbacks.rb:92:in `_run_callbacks'
/var/lib/gems/2.1.0/gems/activesupport-4.2.1/lib/active_support/callbacks.rb:776:in `_run_prepare_callbacks'
/var/lib/gems/2.1.0/gems/activesupport-4.2.1/lib/active_support/callbacks.rb:81:in `run_callbacks'
/var/lib/gems/2.1.0/gems/actionpack-4.2.1/lib/action_dispatch/middleware/reloader.rb:83:in `prepare!'
/var/lib/gems/2.1.0/gems/actionpack-4.2.1/lib/action_dispatch/middleware/reloader.rb:55:in `prepare!'
/var/lib/gems/2.1.0/gems/railties-4.2.1/lib/rails/application/finisher.rb:50:in `block in <module:Finisher>'
/var/lib/gems/2.1.0/gems/railties-4.2.1/lib/rails/initializable.rb:30:in `instance_exec'
/var/lib/gems/2.1.0/gems/railties-4.2.1/lib/rails/initializable.rb:30:in `run'
/var/lib/gems/2.1.0/gems/railties-4.2.1/lib/rails/initializable.rb:55:in `block in run_initializers'
/var/lib/gems/2.1.0/gems/railties-4.2.1/lib/rails/initializable.rb:54:in `run_initializers'
/var/lib/gems/2.1.0/gems/railties-4.2.1/lib/rails/application.rb:352:in `initialize!'
/var/www/redmine/config/environment.rb:14:in `<top (required)>'
/var/lib/gems/2.1.0/gems/activesupport-4.2.1/lib/active_support/dependencies.rb:274:in `require'
/var/lib/gems/2.1.0/gems/activesupport-4.2.1/lib/active_support/dependencies.rb:274:in `block in require'
/var/lib/gems/2.1.0/gems/activesupport-4.2.1/lib/active_support/dependencies.rb:240:in `load_dependency'
/var/lib/gems/2.1.0/gems/activesupport-4.2.1/lib/active_support/dependencies.rb:274:in `require'
/var/lib/gems/2.1.0/gems/railties-4.2.1/lib/rails/application.rb:328:in `require_environment!'
/var/lib/gems/2.1.0/gems/railties-4.2.1/lib/rails/application.rb:457:in `block in run_tasks_blocks'
Tasks: TOP => db:migrate => environment
(See full trace by running task with --trace)
root@redmine www/redmine#
Jeremy Davis's picture

Jeremy Davis - Fri, 2016/03/18 - 02:51
I found them a bit hard to read with all the whitespace so I edited them a bit...

Anyway, as I said I am not very familiar with Ruby but it seems to me like you need to install capybara v1.1.0 but you installed the latest (v2.6.2). Google suggests that you can install specific gem version using the -v switch, so perhaps try: 

gem install capybara -v 1.1.0

Although having said that, I still think that there may be deeper issues with mismatched versions. It does look like things might be pretty messed up on your server. Perhaps it might be wroth starting again in a clean VM? It may not make any difference, but at least you know that it's not failing because of something you recently broke. I still haven't had a chance to look into it myself, but thanks for posting clear instructions.

Rafael de Almeida's picture

Rafael de Almeida - Sun, 2016/04/03 - 05:03

Hi!

I'm trying to install this plugin (https://github.com/jperelli/Redmine-Periodic-Task) but appears "oborted rake." How can I solve this?

 

root@redmine ~# cd /usr/local/share/redmine
root@redmine share/redmine# git clone http://github.com:/jperelli/Redmine-Periodic-Task.git plugins/periodictask
Cloning into 'plugins/periodictask'...
remote: Counting objects: 410, done.
remote: Total 410 (delta 0), reused 0 (delta 0), pack-reused 410
Receiving objects: 100% (410/410), 57.84 KiB | 0 bytes/s, done.
Resolving deltas: 100% (161/161), done.
Checking connectivity... done.
root@redmine share/redmine# rake redmine:plugins:migrate NAME=periodictask RAILS_ENV=production
rake aborted!
No Rakefile found (looking for: rakefile, Rakefile, rakefile.rb, Rakefile.rb)

(See full trace by running task with --trace)

Thanks!!!

Rafael de Almeida's picture

Rafael de Almeida - Sun, 2016/04/03 - 21:33 
Environment:
  Redmine version                3.2.0.stable
  Ruby version                   2.1.5-p273 (2014-11-13) [x86_64-linux-gnu]
  Rails version                  4.2.5
  Environment                    production
  Database adapter               Mysql2
SCM:
  Subversion                     1.8.10
  Mercurial                      3.1.2
  Bazaar                         2.7.0
  Git                            2.1.4
  Filesystem                     
Redmine plugins:
  no plugin installed
Rafael de Almeida's picture

Rafael de Almeida - Tue, 2016/04/05 - 15:42

Please could someone help me solve the question above?
Thank you,
Rafael.

Jeremy Davis's picture

Jeremy Davis - Thu, 2016/04/07 - 06:31
I'd really love to help you out, but I'm really bogged down with other stuff at the moment. So unfortunately don't have the time right now to get my hands dirty sorry.

Having said that, I think I might know what is going on. If you look at the error you are getting it's saying that it can't find the files that it's looking for. That suggests that you are in the wrong place in the filesystem. Looking at previous posts in this thread it seems that Redmine is installed to /var/www/redmine so my guess is that is where you should be rather than /usr/local/share/redmine...

I hope that might help get you going in the right direction...

Rafael de Almeida's picture

Rafael de Almeida - Thu, 2016/04/07 - 15:31

thanks for the answer!

Post new comment