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

Install Ruby dependencies with Bundler:
```
 bundle install
```
Install JavaScript dependencies with npm:
```
 npm install
```

Configure Rails

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.
Copy config/configuration.yml.example to config/configuration.yml:
```
 cp configuration.yml.example configuration.yml
 cd ..
```
Edit configuration.yml according to your preferred settings for email, etc. (see config/CONFIGURATION.md for a full list of configuration options).

Create databases, schemas and populate with seed data:

 # bundle exec rake db:create:all
 # bundle exec rake db:migrate
 # bundle exec rake db:seed

Generate a secret token for the session store:
```
 bundle exec rake generate_secret_token
```

Run!

In development, bundle JavaScript assets using Webpack:
```
 ./node_modules/webpack/bin/webpack.js
```
Pass the -w flag to keep Webpack watching for changes.

In production, this step is executed as part of rake assets:precompile task.
Start Rails:
```
 bundle exec rails server
```

3.3 KiB Raw Blame History