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: Before installing a plugin, make sure that the plugin is compatible with your OpenProject version.

OpenProject plug-ins are separated in Ruby gems. You can install them by including the gems in the installdir/apps/openproject/htdocs/Gemfile.plugins file. An example of a Gemfile.plugins file looks like this:

# Required by backlogs
gem "openproject-pdf_export", git: "", :branch => "stable"
gem "openproject-backlogs", git: "", :branch => "stable"

Then, to install the plugin, run the following commands:

$ cd installdir
$ cd apps/openproject/htdocs
$ bundle install --no-deployment --without development test postgres sqlite
$ bower install --allow-root
$ RAILS_ENV="production" bundle exec rake db:migrate
$ RAILS_ENV="production" bundle exec rake db:seed
$ RAILS_ENV="production" bundle exec rake assets:precompile
$ touch tmp/restart.txt

The next Web request to the server will take longer (as the application is restarted). All subsequent requests should be as fast as always.


If you run the previous commands as the root user, change permissions of the tmp/ folder:

$ chown -R daemon:daemon installdir/apps/openproject/htdocs/tmp
Last modification April 8, 2020