openproject/doc/INSTALL.md

Install

Detailed installation instructions for different platforms are located on the OpenProject website.

You can find information on configuring OpenProject in config/CONFIGURATION.md.

Fast install

These are generic (and condensed) installation instructions for the current dev branch without plugins, and optimised for a development environment. Refer to the OpenProject website for instructions for the stable branch, OpenProject configurations with plugins, as well as platform-specific guides.

Prerequisites

• Git
• Database (MySQL 5.x/PostgreSQL 8.x)
• Ruby 2.1.x
• Node.js (version v0.10.x)
• Bundler (version 1.5.1 or higher required)

Install Dependencies

1. Install Ruby dependencies with Bundler:

    bundle install
   

2. Install JavaScript dependencies with npm and Bower:

    npm -g install bower
    npm install
    bower install
   

Configure Rails

1. Copy config/database.yml.example to config/database.yml:

    cd config
    cp database.yml.example database.yml
   

   Edit database.yml according to your preferred database's settings.

2. Copy config/configuration.yml.example to config/configuration.yml:

    cp configuration.yml.example configuration.yml
   

   Edit configuration.yml according to your preferred settings for email, etc. (see config/CONFIGURATION.md for a full list of configuration options).

3. Create databases, schemas and populate with seed data:

    bundle exec rake db:setup
   
    # - OR - in multiple steps:
    # bundle exec rake db:create:all
    # bundle exec rake db:migrate
    # bundle exec rake db:seed
   

4. Generate a secret token for the session store:

    bundle exec rake generate_secret_token
   

Run!

1. Start Rails:

    bundle exec rails server