Top Menu

Jump to content
Home
    • Projects
    • Work packages
    • News
    • Getting started
    • Introduction video
      Welcome to OpenProject Community
      Get a quick overview of project management and team collaboration with OpenProject. You can restart this video from the help menu.

    • Help and support
    • User guides
    • Videos
    • Shortcuts
    • Community forum
    • Professional support

    • Additional resources
    • Data privacy and security policy
    • Digital accessibility (DE)
    • OpenProject website
    • Security alerts / Newsletter
    • OpenProject blog
    • Release notes
    • Report a bug
    • Development roadmap
    • Add and edit translations
    • API documentation
  • Sign in
      Forgot your password?
      Create a new account

      or sign in with your existing account

      Google

Side Menu

  • Overview
  • Activity
  • Roadmap
  • Work packages
  • Calendars
  • Team planners
  • Boards
  • Forums
  • Wiki
    • Table of contents
      • Expanded. Click to collapseCollapsed. Click to showDeveloper
        • Hierarchy leafAccessibility Checklist
        • Hierarchy leafCode Review Guidelines
        • Expanded. Click to collapseCollapsed. Click to showContribution
          • Hierarchy leafGit Workflow
          • Hierarchy leafTranslations
        • Expanded. Click to collapseCollapsed. Click to showDeveloping Plugins
          • Hierarchy leafDeveloping an OmniAuth Authentication Plugin
        • Hierarchy leafRelease Process
        • Hierarchy leafReport a bug
        • Hierarchy leafSecurity
        • Hierarchy leafSetting up an OpenLDAP server for testing
        • Hierarchy leafTheme Features
      • Hierarchy leafDownload
      • Expanded. Click to collapseCollapsed. Click to showFeature tour
        • Hierarchy leafRelease Notes OpenProject 30
        • Expanded. Click to collapseCollapsed. Click to showRelease Notes OpenProject 30 - Overview
          • Hierarchy leafGlossary
          • Hierarchy leafRelease Notes - Accessibility
          • Hierarchy leafRelease Notes - Accessibility changes
          • Hierarchy leafRelease Notes - Add work package queries as menu items to sidebar
          • Hierarchy leafRelease Notes - Copy projects based on Templates
          • Hierarchy leafRelease Notes - Design changes
          • Hierarchy leafRelease Notes - Fixed Bugs
          • Hierarchy leafRelease Notes - Keyboard Shortcuts
          • Hierarchy leafRelease Notes - Project settings
          • Hierarchy leafRelease Notes - Ruby&Rails Update
          • Hierarchy leafRelease Notes - Security
          • Hierarchy leafRelease Notes - Timelines
          • Hierarchy leafRelease Notes - Work packages
      • Hierarchy leafHowto create animated gifs
      • Hierarchy leafMigration Squashing
      • Hierarchy leafMod security
      • Hierarchy leafNew work package page
      • Hierarchy leafOP3 to OP4 Debian upgrade
      • Hierarchy leafOP4 Ubuntu1404 Stable with MySQL in production
      • Hierarchy leafOpenProject 40 Development Setup
      • Expanded. Click to collapseCollapsed. Click to showOpenProject Foundation
        • Hierarchy leafBoards
        • Hierarchy leafMembers
        • Hierarchy leafOPF-Meetings
        • Hierarchy leafStatutes
      • Expanded. Click to collapseCollapsed. Click to showRelease Notes
        • Hierarchy leafOpenProject released on Bitnami
      • Expanded. Click to collapseCollapsed. Click to showRelease Notes OpenProject 40 - Overview
        • Hierarchy leafRelease Notes OpenProject 40 - Accessibility improvements
        • Hierarchy leafRelease Notes OpenProject 40 - Column header functions in work package table
        • Hierarchy leafRelease Notes OpenProject 40 - Improved Design
        • Hierarchy leafRelease Notes OpenProject 40 - Integrated query title on work package page
        • Hierarchy leafRelease Notes OpenProject 40 - Integrated toolbar on work package page
        • Hierarchy leafRelease Notes OpenProject 40 - OmniAuth integration for OpenProject
        • Hierarchy leafRelease Notes OpenProject 40 - Work package details pane
      • Expanded. Click to collapseCollapsed. Click to showSecurity and privacy
        • Hierarchy leafFAQ
      • Expanded. Click to collapseCollapsed. Click to showSupport
        • Expanded. Click to collapseCollapsed. Click to showDownload and Installation
          • Hierarchy leafInstallation MacOS
          • Expanded. Click to collapseCollapsed. Click to showInstallation OpenProject 3 0
            • Hierarchy leafDebian Stable with MySQL in production
            • Hierarchy leafInstallation Ubuntu
            • Hierarchy leafInstallation Windows
            • Hierarchy leafInstallation on Centos 65 x64 with Apache and PostgreSQL 93
          • Expanded. Click to collapseCollapsed. Click to showInstallation OpenProject 40
            • Hierarchy leafOP4 Debian Stable with MySQL in production
          • Expanded. Click to collapseCollapsed. Click to showMigration paths
            • Hierarchy leafFrom Chilliproject to OpenProject
            • Hierarchy leafMigration 15 to 30
            • Hierarchy leafMigration 24 to 30
            • Hierarchy leafMigration Redmine 2x › OpenProject 30
            • Hierarchy leafOpenProject 3 Migration
          • Hierarchy leafOpenProject 40
        • Expanded. Click to collapseCollapsed. Click to showNews
          • Hierarchy leafNew OpenProject Translations Plugin
          • Hierarchy leafNew Plugin on OpenProjectorg Local Avatars
          • Hierarchy leafNew design for OpenProject
          • Hierarchy leafNews Accessibility workshop for OpenProject
          • Hierarchy leafNews Glossary for OpenProject
          • Hierarchy leafNews Heartbleed fixed
          • Hierarchy leafNews Icon Fonts
          • Hierarchy leafNews OpenProject 30 Release
          • Hierarchy leafNews Release GitHub Integration Plugin
          • Hierarchy leafNews Success Story Deutsche Telekom
          • Hierarchy leafNews Timelines
          • Hierarchy leafOpenProject 3013 released
          • Hierarchy leafOpenProject 3017 released
          • Hierarchy leafOpenProject 40 released
          • Hierarchy leafOpenProject 40 will be coming soon
          • Hierarchy leafOpenProject 405 released
          • Hierarchy leafOpenProject and pkgrio
          • Hierarchy leafOpenProject news moved to a new blog
          • Hierarchy leafOpenProjectBitnami
          • Hierarchy leafPackager version with plugins released ("Community edition")
          • Hierarchy leafRegistration OpenProject-Foundation
          • Hierarchy leafRelease OpenProject AuthPlugins
          • Hierarchy leafUpdates on OpenProject
          • Hierarchy leafWe need your feedback for the the new fullscreen view for work packages
        • Hierarchy leafOpenProject Plug-Ins
      • Hierarchy leafWiki
You are here:
  • Forums
  • Support Installation & Updates

Content

Step-by-Step-Guide to install plugins

Added by Martin Böhm over 8 years ago

Hi,

I want to extend an existing openproject instance on debian. There I want to install the Backlogs- and the PDF-Export plugin. At https://gist.github.com/crohr/10111721 I found a description. At the the end I see “sudo service openproject restart”. Is openproject installed as service or what does this call meen?

How do I install openproject as a service.

Thanks in Advance


Replies (12)

RE: Step-by-Step-Guide to install plugins - Added by Philipp Tessenow over 8 years ago

Hi Martin,

to give you a good answer, can you please tell us how you’ve installed OpenProject (there are different ways, each resulting in a slightly different way to install plugins)

cheers,
Philipp

RE: Step-by-Step-Guide to install plugins - Added by Martin Böhm over 8 years ago

I’m not sure, but I think it was installed by the description here: https://www.openproject.org/projects/openproject/wiki/Debian_Stable_with_MySQL_in_production.

RE: Step-by-Step-Guide to install plugins - Added by Philipp Tessenow over 8 years ago

In this case https://gist.github.com/crohr/10111721 does not apply (openproject is not installed as a service).

In your case

  1. stop the server
  2. create a Gemfile.plugin file, as described in the plugin documentation page
  3. run bundle install
  4. run RAILS_ENV=production bundle exec rake db:migrate
  5. run RAILS_ENV=production bundle exec rake db:seed
  6. run RAILS_ENV=production bundle exec rake assets:precompile

I hope I covered everything :)

cheers,
Philipp

RE: Step-by-Step-Guide to install plugins - Added by Martin Böhm over 8 years ago

Where do I create the Gemfile.plugin? Do I create it in the openproject-folder besides Gemfile and Gemfile.lock?

Moreover there is an strong outline that the openproject-plugins is required for each plugin. But the plugins list only mentions dependencies to the Backlogs-Plugin, the PDF-Export-Plugin and the Emoji-Plugin. Are there more dependencies? Where do I find a complete list of needed dependencies?

RE: Step-by-Step-Guide to install plugins - Added by Philipp Tessenow over 8 years ago

Martin Böhm wrote:

Where do I create the Gemfile.plugin? Do I create it in the openproject-folder besides Gemfile and Gemfile.lock?

exactly

Moreover there is an strong outline that the openproject-plugins is required for each plugin. But the plugins list only mentions dependencies to the Backlogs-Plugin, the PDF-Export-Plugin and the Emoji-Plugin. Are there more dependencies? Where do I find a complete list of needed dependencies?

openproject-plugins is required by many (but not all) plugins. And your’re right, the backlogs plugins needs openproject-plugins as a dependency (I added it to the list just now).

The emoji-plugin is not needed by any other plugin (I know of).

In general, you can (= should) find complete installation instructions for a plugin at the plugin’s readme (the “source” link in the plugin table).

RE: Step-by-Step-Guide to install plugins - Added by Martin Böhm over 8 years ago

Thanks for your quick reply.

I run bundle install under the recommended openproject-user. But I get the following error:

Gem::Installer::ExtensionBuildError: ERROR: Failed to build gem native extension.

        /usr/bin/ruby1.9.1 extconf.rb
/usr/lib/ruby/1.9.1/rubygems/custom_require.rb:36:in `require': cannot load such file -- mkmf (LoadError)
        from /usr/lib/ruby/1.9.1/rubygems/custom_require.rb:36:in `require'
        from extconf.rb:19:in `<main>'


Gem files will remain installed in /tmp/bundler20140610-13056-10jr4o8/binding_of_caller-0.7.2/gems/binding_of_caller-0.7.2 for inspection.
Results logged to /tmp/bundler20140610-13056-10jr4o8/binding_of_caller-0.7.2/gems/binding_of_caller-0.7.2/ext/binding_of_caller/gem_make.out
An error occurred while installing binding_of_caller (0.7.2), and Bundler cannot continue.
Make sure that `gem install binding_of_caller -v '0.7.2'` succeeds before bundling.

What does this mean? What is missing or how can I work around?

Thanks for your reply.

RE: Step-by-Step-Guide to install plugins - Added by Martin Böhm over 8 years ago

The error origins from missing ruby-dev. I googled around and found the following solution:
sudo apt-get install ruby-dev

Then I called “bundle install” again.

RE: Step-by-Step-Guide to install plugins - Added by Martin Böhm over 8 years ago

I’ve ran all your commands successfully. Thereafter I started “service apache2 start”. But at the administration web interface the plugins are missing.

Do I have to restart the openproject server? How do I restart the openproject application or is it started up by apache2?

RE: Step-by-Step-Guide to install plugins - Added by Philipp Tessenow over 8 years ago

The passenger process might still be running (passenger is a webserver, that can run openproject and serves it to apache). You can restart passenger through creating/touching a file called restart.txt. You can find (or create) that file at <path to your openproject installation>/tmp/restart.txt.

Passenger is restarted on the next web-request (this implies that the next request might take much longer).

Have a look at the passenger documentation for details.

This way you can restart OpenProject without restarting apache (and with it probably your whole site) every time.

RE: Step-by-Step-Guide to install plugins - Added by Martin Böhm over 8 years ago

Done! But plugins are not shown.

At my apache2 error.log I found this lines:

[ 2014-06-11 08:26:13.9493 2356/7f7b71558700 Pool2/SmartSpawner.h:297 ]: Preloader for /home/openproject/openproject started on PID 3270, listening on unix:/tmp/passenger.1.0.2316/generation-0/backends/preloader.3270
App 3381 stdout: 
[Wed Jun 11 08:38:21 2014] [notice] caught SIGTERM, shutting down
[ 2014-06-11 08:38:25.3086 3806/7f6adb33c720 agents/Watchdog/Main.cpp:538 ]: Options: { 'analytics_log_user' => 'nobody', 'default_group' => 'nogroup', 'default_python' => 'python', 'default_ruby' => '/home/openproject/.rvm/gems/ruby-2.1.0/wrappers/ruby', 'default_user' => 'nobody', 'log_level' => '0', 'max_pool_size' => '6', 'passenger_root' => '/home/openproject/.rvm/gems/ruby-2.1.0/gems/passenger-4.0.44', 'passenger_version' => '4.0.44', 'pool_idle_time' => '300', 'temp_dir' => '/tmp', 'union_station_gateway_address' => 'gateway.unionstationapp.com', 'union_station_gateway_port' => '443', 'user_switching' => 'true', 'web_server_passenger_version' => '4.0.44', 'web_server_pid' => '3805', 'web_server_type' => 'apache', 'web_server_worker_gid' => '33', 'web_server_worker_uid' => '33' }
[ 2014-06-11 08:38:25.3231 3809/7f0bebce1720 agents/HelperAgent/Main.cpp:649 ]: PassengerHelperAgent online, listening at unix:/tmp/passenger.1.0.3805/generation-0/request
[ 2014-06-11 08:38:25.3393 3815/7fca20cf5740 agents/LoggingAgent/Main.cpp:321 ]: PassengerLoggingAgent online, listening at unix:/tmp/passenger.1.0.3805/generation-0/logging
[ 2014-06-11 08:38:25.3408 3806/7f6adb33c720 agents/Watchdog/Main.cpp:728 ]: All Phusion Passenger agents started!
[ 2014-06-11 08:38:25.4124 3831/7f03e4cbd720 agents/Watchdog/Main.cpp:538 ]: Options: { 'analytics_log_user' => 'nobody', 'default_group' => 'nogroup', 'default_python' => 'python', 'default_ruby' => '/home/openproject/.rvm/gems/ruby-2.1.0/wrappers/ruby', 'default_user' => 'nobody', 'log_level' => '0', 'max_pool_size' => '6', 'passenger_root' => '/home/openproject/.rvm/gems/ruby-2.1.0/gems/passenger-4.0.44', 'passenger_version' => '4.0.44', 'pool_idle_time' => '300', 'temp_dir' => '/tmp', 'union_station_gateway_address' => 'gateway.unionstationapp.com', 'union_station_gateway_port' => '443', 'user_switching' => 'true', 'web_server_passenger_version' => '4.0.44', 'web_server_pid' => '3826', 'web_server_type' => 'apache', 'web_server_worker_gid' => '33', 'web_server_worker_uid' => '33' }
[ 2014-06-11 08:38:25.4294 3838/7fa496dad720 agents/HelperAgent/Main.cpp:649 ]: PassengerHelperAgent online, listening at unix:/tmp/passenger.1.0.3826/generation-0/request
[ 2014-06-11 08:38:25.4459 3846/7fea8bde0740 agents/LoggingAgent/Main.cpp:321 ]: PassengerLoggingAgent online, listening at unix:/tmp/passenger.1.0.3826/generation-0/logging
[ 2014-06-11 08:38:25.4473 3831/7f03e4cbd720 agents/Watchdog/Main.cpp:728 ]: All Phusion Passenger agents started!
[Wed Jun 11 08:38:25 2014] [notice] Apache/2.2.22 (Debian) DAV/2 SVN/1.6.17 Phusion_Passenger/4.0.44 configured -- resuming normal operations
App 3934 stdout: 
App 3934 stdout: require 'rails/all'... 0.450s
App 3934 stdout: Bundler.require... 1.280s
App 3934 stderr: [deprecated] I18n.enforce_available_locales will default to true in the future. If you really want to skip validation of your locale you can set I18n.enforce_available_locales = false to avoid this message.
App 3934 stderr: /home/openproject/.rvm/gems/ruby-2.1.0/gems/svg-graph-1.0.5/lib/SVG/Graph/Graph.rb:3: warning: class variable access from toplevel
App 3934 stdout: Application.initialize!... 3.730s
[ 2014-06-11 08:38:37.8962 3838/7fa4943ea700 Pool2/SmartSpawner.h:297 ]: Preloader for /home/openproject/openproject started on PID 3934, listening on unix:/tmp/passenger.1.0.3826/generation-0/backends/preloader.3934
App 4052 stdout: 

What are the implications? What do I need to do?

RE: Step-by-Step-Guide to install plugins - Added by Philipp Tessenow over 8 years ago

I had a private conversation with Martin to find the problem. It turned out, that the installation guide recommended to use the Gemfile.plugin file. But it should have been Gemfile.plugins (note the missing ‘s’).

Fortunately, Martin found the flaw and fixed the documentation. Thanks!

RE: RE: Step-by-Step-Guide to install plugins - Added by Igor Šovčík over 6 years ago

hi, we have same problem installing omniauth plugin. We have openproject installed via bitnami stack on google compute engine.
We can not install the plugin. Do you have any solution? It is fresh install of open project and we like to include omniauth in it.

  • (1 - 12/12)
Loading...