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:
  • Support
  • News
  • OpenProject and pkgrio

Content

OpenProject and pkgrio

  • More
    • Print
    • Table of contents

tl;dr: The OpenProject installation has become much easier. Jump to the “The good news: Installing OpenProject is easy now” section to find out how much.

The current way to install OpenProject is difficult

OpenProject is a great project collaboration tool. We hear from many people who are really enthusiastic about it after they played with our demo pages.

Unfortunately, installing OpenProject has proven to be a pain. When reading through our support forums you can observe that pain. We know, it is hard to get the ruby stack running (choose the right ruby version, have all the dependencies installed, install gems, google for errors that tend to happen often) and our installation guides are very technical and provide tons of steps.

Great members of the OpenProject community (like Karol, or this other anonymous guy) contributed better guides. They are good guides, but still hard to follow for non tech-savvy people.

The good news: Installing OpenProject is easy now

Debian packages are the standard way to install software on Debian based Linux distributions. pkgr.io is a service that takes a rails (or node) application and packs it in a Debian package.
Using pkgr, installing OpenProject on Ubuntu 14.04 (64 bit) system has become pretty easy (given that you have a MySQL or Postgresql database at hand).

wget -qO - https://deb.pkgr.io/key | sudo apt-key add -
echo "deb https://deb.pkgr.io/tessi/openproject trusty feature/pkgr" | sudo tee -a /etc/apt/sources.list.d/pkgr.list
sudo apt-get update
sudo apt-get install openproject

sudo openproject config:set SECRET_TOKEN=$(sudo openproject run rake secret | tail -1)
sudo openproject config:set DATABASE_URL=mysql2://user:pass@host:port/dbname

sudo openproject run rake db:migrate
sudo openproject run rake db:seed
sudo openproject scale web=1 worker=1
sudo service openproject start

That’s it! Now, you have a running OpenProject at http://localhost:8080 (note: if you want to make OpenProject publicly available follow the instructions at the pkgr.io FAQ for instructions).

Have a look at the pkgr page for detailed installation and update instructions

Our way to a better installation experience

pkgr promises to be

The easiest way to get a debian package out of your Ruby or Node app

Well, let’s see if it can hold to this promise and let me show you the changes necessary to let OpenProject work with pkgr.io.

The first thing I noticed is that pkgr has a good documentation page. It is a lot to read, so let’s just start and follow the documentation while we’re working at the real thing.

First, I forked OpenProject from their GitHub repository opf/openproject to tessi/openproject and created a branch for our experiement named feature/pkgr. The pkgr documentation tells us to create a" .pkgr.yml":https://github.com/tessi/openproject/blob/feature/pkgr/.pkgr.yml file which we do:

user: openproject
group: openproject
before_precompile: ./packaging/debian/setup.sh

Note the before_precompile. It is a pkgr.io hook that is run just before the asset precompilation starts at their build servers. Some rails apps (like OpenProject) need a running database for asset compilation, so we start a Postgresql server in packaging/debian/setup.sh :

# we need postgresql for asset precompilation
# see: https://pkgr.io/doc
sudo service postgresql start

We run OpenProject with the unicorn webserver.
Trough a Procfile we can define the processes being started to run OpenProject:

web: bundle exec unicorn
worker: bundle exec rake jobs:work

Oh, and of course we need to add the unicorn gem to our bundle. Therefore, we add the following Gemfile.local :

ruby '2.1.1'
group :production do
  gem 'rails_12factor'
  gem 'unicorn'
end

Now we commit the changes (including Gemfile.local which happens to be listed in .gitignore) to the feature/pkgr branch and continue at pkgr.io.

Here we sign in with our GitHub account, click the big green “Add new app” button, and select our repository. In the following settings page we can configure our app:

Now we can build debian packages!

What really surprised me in a positive way is that Cyril, the pkgr founder, found my changes and cared enough to help, he even added OpenProject to his showcase projects.

There are still some things left to be considered. For example, we need a good way to fully automate package building, to handle plugins, or to incorporate our latest angular-js changes.
This being said, we think that the Debian package installation is one step to a better installation experience and might become an officially supported installation method.

We’re happy to hear from your experiences with this new way to install OpenProject.

Loading...