How to Install Redmine - A Project Management Tool

Installing Redmine could be a bit typical if you haven’t already worked with “Ruby on Rails”. It is not because it needs knowledge of Ruby on Rails, but it has dependency on some of the related software. Installation of these software make take some basic knowledge or ‘hit ‘n try’. We are trying to summarize the steps in sequence here (tried for windows only):
  • Visit to Redmine WIKI for installation instructions. These are useful, but a bit confusing for a new user to Ruby. Still you will get some good information from here, almost complete. 
    • http://www.redmine.org/wiki/redmine/RedmineInstall 
  • Download the latest stable version of Redmine from the SVN.
    • http://www.redmine.org/wiki/redmine/Download 
  • You need to download a few other softwares which are given below with corresponding website. Make sure to follow the version compatibility matrix given on RedmineInstall page at WIKI. Also please note that installing "Rails" may install Rake and Rack automatically. You can check that from the log on screen. If it is installing these, you are done with these installations and hence can skip the steps for their installation and directly go to installation of mysql using gem
    • Rake - http://rake.rubyforge.org/ 
    • RubyGems - http://rubygems.org/pages/download 
    • Ruby – Ruby Installer - http://www.ruby-lang.org/en/downloads/ 
    • Rack - http://rack.rubyforge.org/ 
    • MySql – http://dev.mysql.com/downloads/mysql/ 
  • If you are downloading the Stable Version of Redmine, then you will find the rails in the vendor directory of Redmine root folder.
  • Now at first, install the Ruby using Ruby Installer. Enable the option to include it in system path
  • Install MySql. Do remember the password which you are giving for the administrator user.
  • Open MySql command prompt and execute following commands to create the basic setup in database for Redmine 
    • create database redmine character set utf8; 
    • create user 'redmine'@'localhost' identified by 'my_password'; 
      • You can choose any user name of password.
    • grant all privileges on redmine.* to 'redmine'@'localhost'; 
  •  Now go to the config directory of Redmine root folder. Copy the given same file for database configuration, and rename it to database.yml 
  • There you will find settings for different deployment mode i.e. production, development, test etc. 
  • Update the settings in required mode by putting the above created user and password name, and with database name also if you have not choose ‘redmine’ as database name. 
  • You may need to install the RubyGem. For that, go to RubyGem root directory and install it using setup.rb. 
    • ruby setup.rb 
  • After that you may need to install Rails. Install it like 
    • gem install rails -v=2.3.5
  • Now you need to install Rake. 
    • Ensure that you have ‘libmySQL.dll’ in bin directory of Ruby. 
    • If it is not there, download one from any one of these location and place it there 
      • http://instantrails.rubyforge.org/svn/trunk/InstantRails-win/InstantRails/mysql/bin/libmySQL.dll 
      • http://instantrails.rubyforge.org/svn/trunk/InstantRails-win/vendors/MySQL-Ruby%202.7.3/ - I found this one is working for me 
      • You may need to try with some versions, if you are working with some updated version and the downloaded file is not working for you. 
    • You may try to install mysql, as sometimes it is not there by default. Install it using 
      • gem install mysql
    • If you have not put that ‘libmySQL.dll’ in bin directory, gem will try to download the required version. However sometime you will get ‘403’ error. So put that file before installing mysql. 
  • Install Rake using 
    • gem install rack -v=1.0.1
  • Now generate a session store secret using Rake command 
    • rake generate_session_store
  • Set the Rails environment to desired one like to production 
    • set RAILS_ENV=production
  • Configure and load the default database to Redmine database 
    • rake db:migrate
    • rake redmine:load_default_data
  • Now installation is done for the basic Redmine, you can install as many plugins as you want 
  • Run the inbuilt web server using 
    • ruby script/server webrick -e production
  • But the above web server is for testing or development only. For production, you should use other web servers like Apache, Apache Tomcat or Mongrel.
  • Refer to 'http://www.redmine.org/wiki/redmine/HowTos' for the procedure to  install other servers.
  • For running with Mongrel Server,
  • You can access the application at http://localhost:3000/ 
  • The default user name and password is ‘admin’, ‘admin’. Once login, you can change these and can create other users also 
  • For email configuration, follow the instructions given at http://www.redmine.org/wiki/redmine/EmailConfiguration. These need to be updated in “config/email.yml” file. 
    • You need to download "action_mailer_optional_ts" from https://github.com/collectiveidea/action_mailer_optional_tls and put it in redmine/vendor/plugins directory. This is required for sending the mails using gmail etc as these require secure communication using ssl or tls.
  • For configuring the backup of redmine, follow the instructions given at RedmineInstall page at WIKI. 
There are some bundled installers provided by third party, whose link you can find from RemineInstall page. I was unable to download these due to some error at their site, so got a chance to write all these contents for other user of Redmine.

Happy using Redmine. It is really a nice Project Management Tool, very Simple in use and still powerful, does not have less and does have more. Good work done by Redmine team!!

People who read this post also read :



1 comments:

Mohit Gupta said...

Pick the 'libmysql.dll' from following address. It usually has updated jar and works with current version - http://instantrails.rubyforge.org/svn/trunk/InstantRails-win/InstantRails/mysql/bin/libmySQL.dll

Post a Comment