Installation on Windows¶

These are the simplest set of instructions that I used for getting a complete ChiliProject 2.3.0 installation up and running on a clean Windows system using the webrick webserver that comes bundled with Ruby.
Please note that running ChiliProject on webrick is not recommended for a production environment.

Install Ruby¶

1. Download version 1.8.7 of the RubyInstaller for Windows from http://rubyinstaller.org/downloads (at time of writing this was rubyinstaller-1.8.7-p352.exe)
2. Run the installer to install Ruby:
   • my preferred location is C:\Ruby\Ruby187
   • make sure you check the checkbox to Add Ruby executables to your PATH
   • the rest of the options are up to you

Install Ruby DevKit (required for installing gems)¶

1. Download the Development Kit from the same site http://rubyinstaller.org/downloads (at time of writing this was DevKit-tdm-32-4.5.2-20110712-1620-sfx.exe)
2. Run the exe to extract the DevKit files
   • my preferred location is C:\Ruby\DevKit
3. After extracting, open a command prompt window, and type the following commands:
   

   cd C:\Ruby\DevKit
   ruby dk.rb init
   ruby dk.rb install
   

Install ImageMagick (required for the RMagick gem for generating images from the Gantt charts)¶

1. Download the latest Q16-windows-dll version of ImageMagick from http://www.imagemagick.org/download/binaries/ (at time of writing this was ImageMagick-6.7.3-0-Q16-windows-dll.exe)
2. Run the installer to install ImageMagick:
   • you can install into the default location (on my system it was C:\Program Files\ImageMagick-6.7.3-Q16)
   • on the last page of the install wizard (Select Additional Tasks), make sure you check at least both of the following checkboxes:
     • Add application directory to your system path
     • Install development headers and libraries for C and C++
   • the other options are up to you (I left them all off)
3. (optional) If you want ImageMagick to use Windows fonts instead of the standard GhostScript fonts:
   1. Download the file http://www.imagemagick.org/source/type-windows.xml
   2. Rename the downloaded file to type-ghostscript.xml
   3. Copy the new type-ghostscript.xml to the ImageMagick install folder C:\Program Files\ImageMagick-6.7.3-Q16\, replacing the file already there (you will probably need to have Administrator privileges for this).

Prepare RMagick gem dependencies¶

To get the RMagick gem to install successfully in Ruby, do the following:

1. Create a file named Magick-config (no file extension) in the ImageMagick install folder C:\Program Files\ImageMagick-6.7.3-Q16\ (you will probably need to have Administrator privileges for this). Copy the following commands into this file:
   

   #! /bin/sh
   case $1 in
     --version ) identify --version | grep Version: | cut -d" " -f3 | cut -d"-" -f1 ;;
     --libs ) echo -lMagick ;;
   esac
   

2. Have a look in the ImageMagick lib folder (C:\Program Files\ImageMagick-6.7.3-Q16\lib\) for a file called Magick.lib:
   • If there is not a file called Magick.lib there, there will probably be a file called something like CORE_RL_magick_.lib instead. Copy this file and rename the copy to Magick.lib in the same folder.
   • NB: Please be very careful with the spelling of Magick in this context (Note the extra "k" at the end)

Install Database server¶

Install PostgreSQL or MySQL.

Setup ChiliProject dependencies¶

1. Get the ChiliProject source code as per the instructions here. Either:
   • download and extract a packaged release from the Files section
     OR
   • if you have Git, check out the latest code from https://github.com/chiliproject/chiliproject:
     

     git clone git://github.com/chiliproject/chiliproject.git
     cd chiliproject
     git checkout stable
     

2. Open a command prompt window
3. Make sure you're in the folder where you put the ChiliProject source code:
   

   cd C:\web\chiliproject
   

4. Make sure you have the latest rubygems system:
   

   gem update --system
   

5. Install the bundler gem:
   

   gem install bundler
   

6. Setup the DevKit environment for compiling RMagick:
   Put the following environment variables into your System Settings and start a new command shell afterwards.
   

   set IMAGEMAGICK_PATH=C:\Program Files\ImageMagick-6.7.3-Q16
   set LIBRARY_PATH=%IMAGEMAGICK_PATH%\lib
   set CPATH=%IMAGEMAGICK_PATH%\include
   

1. Install all the required ruby gems for ChiliProject:
   • NB 1: For some reason on my system the Ruby interpreter crashes whilst installing rmagick, but this does not seem to affect anything, and it continues to install correctly.
   • NB 2: If you do not have MySQL already installed (eg. if you intend using PostgreSQL instead), you will need to exclude the mysql2 gem from the bundle, otherwise bundler will fail because of missing libraries. So in this case use the command bundle install --without=mysql2 instead.
   • NB 3: It might be, that even with installed MySQL, you have to put a libmySQL.dll into your ruby/bin directory. If the one from the Installation isn't working, there are a couple of different versions available, e.g. the PHP Distribution for Windows is including one.
   • NB 4: Not all dependencies are required, especially not all database adapters. See the documentation for setting up bundler and choose the settings that are appropriate for you.
     

     bundle install
     

Configure ChiliProject before first run¶

1. Open a command prompt window
2. Make sure you're in the folder where you put the ChiliProject source code:
   

   cd C:\web\chiliproject
   

3. Set the production environment to be configured:
   

   set RAILS_ENV=production
   

4. Continue with the instructions from number 3 (Create an empty database) to number 8 (default configuration data) underneath Installation on the standard ChiliProject installation page (copied below):
   1. Create an empty database and an accompanying user named chiliproject for example.
      • MySQL < 5.0.2
        

        create database chiliproject character set utf8;
        grant all privileges on chiliproject.* to 'chiliproject'@'localhost' identified by 'my_password';
        

      • MySQL >= 5.0.2
        

        create database chiliproject character set utf8;
        create user 'chiliproject'@'localhost' identified by 'my_password';
        grant all privileges on chiliproject.* to 'chiliproject'@'localhost';
        

      • PostgreSQL
        

        CREATE ROLE chiliproject LOGIN ENCRYPTED PASSWORD 'my_password' NOINHERIT VALID UNTIL 'infinity';
        CREATE DATABASE chiliproject WITH ENCODING='UTF8' OWNER=chiliproject;
        

   2. Copy config/database.yml.example to config/database.yml and edit this file in order to configure your database settings for "production" environment. Valid examples are:
      • MySQL
        

        production:
          adapter: mysql
          database: chiliproject
          host: localhost
          port: 3306
          username: chiliproject
          password: my_password
        

      • PostgreSQL
        

        production:
          adapter: postgresql
          database: chiliproject
          host: localhost
          port: 5432
          username: chiliproject
          password: my_password
          encoding: utf8
        

      • SQLite
        

        production:
          adapter: sqlite3
          database: db/production.db
        

   3. Copy config/configuration.yml.example to config/configuration.yml and edit this file for your system's environment. You can check the comments in the file and on Configuration File for all of the options.
   4. Generate a session store secret.
      

      bundle exec rake generate_session_store

   5. Create the basic database structure by running the following command under the application root directory:
      

      bundle exec rake db:migrate
      

      It will create the database tables and an administrator account.
   6. Insert default configuration data into the database, by running the following command:
      

      bundle exec rake redmine:load_default_data
      

      This step is optional but highly recommended. It will load default roles, trackers, statuses, workflows and enumerations. If you choose to skip this step, you can later define your own configuration from scratch.

Launch ChiliProject to test¶

1. Open a command prompt window
2. Make sure you're in the folder where you put the ChiliProject source code:
   

   cd C:\web\chiliproject
   

3. Launch the bundled Webrick web server:
   

   bundle exec ruby script/server -e production
   

4. Once Webrick has started, point your browser to http://localhost:3000/. You should now see the application welcome page.
   Webrick is not suitable for normal use, please only use Webrick for testing that the installation up to this point is functional. It is not recommended to use Webrick for anything other than development or testing. Use one of the many other guides in this wiki to setup ChiliProject with a real application server like Phusion Passenger (mod_rails), Unicorn, or Thin.
5. Use the default administrator account to log in:
   • Login: admin
   • Password: admin
6. You can now go to Administration to modify the basic application settings. Have a look at the user guide for information on how to configure your new ChiliProject server.