User Tools

Site Tools


tutorials:redmine

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Both sides previous revision Previous revision
Next revision
Previous revision
tutorials:redmine [2010/03/05 20:27]
razvan started new Redmine installation & configuration tutorial (using a Debian-based Redmine package)
tutorials:redmine [2020/07/20 09:16] (current)
Line 1: Line 1:
-= Redmine =+====== Redmine ======
  
-* Install and configure Redmine on Debian+   Install and configure Redmine on Debian
  
-== Installation ==+===== Installation =====
  
-* Debian GNU/Linux Testing (squeeze) repositories contain a Redmine package. If you are using Debian GNU/Linux Lenny (stable version), make sure you add a //testing// repository in {{{/etc/apt/sources.list}}}<code>+   Debian GNU/Linux Testing (squeeze) repositories contain a Redmine package. If you are using Debian GNU/Linux Lenny (stable version), make sure you add a //testing// repository in {{{/etc/apt/sources.list}}}<code>
 deb http://ftp.ro.debian.org/debian testing main contrib non-free deb http://ftp.ro.debian.org/debian testing main contrib non-free
 deb-src http://ftp.ro.debian.org/debian testing main contrib non-free deb-src http://ftp.ro.debian.org/debian testing main contrib non-free
 </code> </code>
-* Update packages & install Redmine using {{{apt-get}}}:<code>+   Update packages & install Redmine using {{{apt-get}}}:<code>
 rosedu:~# apt-get update rosedu:~# apt-get update
 rosedu:~# apt-get install redmine rosedu:~# apt-get install redmine
 </code> </code>
-* In the configuration dialog, I prefer selecting an [[http://www.sqlite.org/ | sqlite3]] database as there is no need for a database daemon or configuration overhead. +   In the configuration dialog, I prefer selecting an [[http://www.sqlite.org/ | sqlite3]] database as there is no need for a database daemon or configuration overhead. 
-* In case of using Debian GNU/Linux Lenny, I sugest uncommeting the above lines from {{{/etc/apt/sources.list}}}.+   In case of using Debian GNU/Linux Lenny, I sugest uncommeting the above lines from {{{/etc/apt/sources.list}}}. 
 +===== Configuration =====
  
-== Configuration ==+  *  Important files/folders: 
 +    *  {{{/usr/share/redmine/}}} - Redmine installation folder 
 +    *  {{{/etc/redmine/}}} - Redmine configuration folder 
 +    *  {{{/etc/redmine/default/}}} - default Redmine instance configuration folder 
 +    *  {{{/etc/redmine/default/database.yml}}} - default Redmine instance database configuration file 
 +    *  {{{/etc/dbconfig-common/redmine/instances/default.conf}}} - default Redmine instance dbconfig configuration file 
 +    *  {{{/usr/share/doc/redmine/}}} - Redmine Debian documentation 
 +==== Apache2 integration ====
  
 +  *  Use sample configuration file to Apache2 {{{conf.d/}}} folder (I'm using an Apache2 host) ({{{/usr/share/doc/redmine/apache2-alias}}})
 +  *  Update configuration file to suit your needs.
 +  *  Make sure {{{mod_rewrite}}} and {{{mod_fcgid}}} are enabled:<code>
 +rosedu:/usr/share/doc/redmine# a2enmod rewrite
 +Module rewrite already enabled
 +rosedu:/usr/share/doc/redmine# a2enmod fcgid
 +Module fcgid already enabled
 +</code>
 +  *  Restart Apache in order to deploy the configuration.<code>
 +  -  /etc/init.d/apache2 restart
 +</code>
 +
 +==== Basic configuration ====
 +
 +  *  The default administrative account is admin (default password is {{{admin}}})
 +  *  After logging in, it is advised to update the {{{admin}}} account, change password etc.
 +  *  Go to {{{Administration -> Information}}} for a quick checklist of the installation.
 +  *  You should browse the {{{Administration -> Settings}}} menu and configure basic setting for the Redmine installation.
 +==== LDAP authentication ====
 +
 +  *  Please check [[http://www.redmine.org/wiki/1/RedmineLDAP | the official page]] on Redmine LDAP authentication.
 +  *  Go to {{{Administration -> Settings -> Authentication}}}.
 +  *  Click on the LDAP authentication link and fill required fields. For my particular LDAP installation, I filled the following:
 +    *  **Name**: swarm.cs.pub.ro LDAP authentication
 +    *  **Host**: swarm.cs.pub.ro
 +    *  **Port**: 636, LDAPS
 +    *  **Account**: N/A 
 +    *  **Password**: N/A
 +    *  **Base DN**: dc=swarm,dc=cs,dc=pub,dc=ro
 +    *  **On-the-fly user creation**: checked
 +    *  Attributes
 +      *  **Login**: uid
 +      *  **Firstname**: givenName
 +      *  **Lastname**: sn
 +      *  **Email**: mail
 +  *  The **on-the-fly user creation** option allows users to register into Redmine. You don't have to create a Redmine account. Authentication is going to be handled through LDAP.
 +
 +==== HTTPS access ====
 +
 +  *  Create an HTTPS-able Virtual Host and add the following line to the HTTP Virtual Host:<code>
 +Redirect permanent / https://mydomain.com
 +</code>
  
-== Old installation tutorial ==+====== Old Redmine installation tutorial ======
  
-* This tutorial draft is part of the work of installing Redmine from source on a Debian GNU/Linux Testing (squeeze) system.+   This tutorial draft is part of the work of installing Redmine from source on a Debian GNU/Linux Testing (squeeze) system.
  
-=== System settings ===+===== System settings =====
  
-* Debian GNU/Linux Testing (squeeze)<code>+   Debian GNU/Linux Testing (squeeze)<code>
 ixlabs:~# cat /etc/issue ixlabs:~# cat /etc/issue
 Debian GNU/Linux squeeze/sid \n \l Debian GNU/Linux squeeze/sid \n \l
 </code> </code>
-* kernel 2.6.30, CPU Pentium 4 2.66GHz, 1GB RAM<code>+   kernel 2.6.30, CPU Pentium 4 2.66GHz, 1GB RAM<code>
 ixlabs:~# uname -a ixlabs:~# uname -a
 Linux ixlabs 2.6.30-2-686 #1 SMP Sat Sep 26 01:16:22 UTC 2009 i686 GNU/Linux Linux ixlabs 2.6.30-2-686 #1 SMP Sat Sep 26 01:16:22 UTC 2009 i686 GNU/Linux
Line 53: Line 103:
 Swap:         3835         11       3823 Swap:         3835         11       3823
 </code> </code>
-* Apache 2.2.14<code>+   Apache 2.2.14<code>
 ixlabs:~# apache2 -v        ixlabs:~# apache2 -v       
 Server version: Apache/2.2.14 (Debian) Server version: Apache/2.2.14 (Debian)
Line 59: Line 109:
 </code> </code>
  
-=== Scripts ===+===== Scripts =====
  
-* The scripts used throughout the process are stored in [[http://www.example.com|this Git repository]].+   The scripts used throughout the process are stored in [[http://www.example.com|this Git repository]].
  
-=== Installation steps ===+===== Installation steps =====
  
 ==== Install Packages ==== ==== Install Packages ====
Line 73: Line 123:
 ==== Download Redmine ==== ==== Download Redmine ====
  
-* I'm using Subversion to checkout the latest stable branch as described on the [[http://www.redmine.org/wiki/redmine/Download|Redmine download page]].<code>+   I'm using Subversion to checkout the latest stable branch as described on the [[http://www.redmine.org/wiki/redmine/Download|Redmine download page]].<code>
 mkdir -p $FULL_CHECKOUT_PATH mkdir -p $FULL_CHECKOUT_PATH
 svn co http://redmine.rubyforge.org/svn/branches/0.8-stable $FULL_CHECKOUT_PATH svn co http://redmine.rubyforge.org/svn/branches/0.8-stable $FULL_CHECKOUT_PATH
 </code> </code>
-* {{{FULL_CHECKOUT_PATH}}} is the root folder for the Redmine instance; it's {{{/usr/local/lib/redmine-0.8/}}} in my case.+   {{{FULL_CHECKOUT_PATH}}} is the root folder for the Redmine instance; it's {{{/usr/local/lib/redmine-0.8/}}} in my case.
  
-=== Configuration steps ===+===== Configuration steps =====
  
 ==== Update Rails version ==== ==== Update Rails version ====
  
-* The current Redmine stable version (0.8.6, on October 14, 2009) defaults to using Rails 2.1.2. +   The current Redmine stable version (0.8.6, on October 14, 2009) defaults to using Rails 2.1.2. 
-* My Debian (squeeze) installation uses Rails 2.2.3<code>+   My Debian (squeeze) installation uses Rails 2.2.3<code>
 ixlabs:~/repo-admin/ixlabs/redmine# dpkg -l rails ixlabs:~/repo-admin/ixlabs/redmine# dpkg -l rails
 Desired=Unknown/Install/Remove/Purge/Hold Desired=Unknown/Install/Remove/Purge/Hold
Line 93: Line 143:
 ii  rails          2.2.3-1        MVC ruby based framework geared for web appl ii  rails          2.2.3-1        MVC ruby based framework geared for web appl
 </code> </code>
-* I have to comment out the {{{RUBY_GEM_VERSION}}} variable definition in {{{$FULL_CHECKOUT_PATH/config/environment.rb}}} to use the latest installed version<code> +   I have to comment out the {{{RUBY_GEM_VERSION}}} variable definition in {{{$FULL_CHECKOUT_PATH/config/environment.rb}}} to use the latest installed version<code> 
-#RAILS_GEM_VERSION = '2.1.2' unless defined? RAILS_GEM_VERSION+  RAILS_GEM_VERSION = '2.1.2' unless defined? RAILS_GEM_VERSION
 </code> </code>
  
 ==== Configure the database ==== ==== Configure the database ====
  
-* I'm using MySQL as database backend. +   I'm using MySQL as database backend. 
-* First step is creating the database:<code>+   First step is creating the database:<code>
 mysql> create database redmine; mysql> create database redmine;
 Query OK, 1 row affected (0.00 sec) Query OK, 1 row affected (0.00 sec)
Line 110: Line 160:
 Query OK, 0 rows affected (0.00 sec) Query OK, 0 rows affected (0.00 sec)
 </code> </code>
-* I'm using the following script to configure the database for Redmine:<code>+   I'm using the following script to configure the database for Redmine:<code>
  
 </code> </code>
tutorials/redmine.1267813635.txt.gz · Last modified: 2010/03/05 20:27 by razvan