redmine for Debian ================== SUPPORTS SETUP AND UPGRADES OF MULTIPLE DATABASE INSTANCES ---------------------------------------------------------- This redmine package is designed to automatically configure database BUT NOT the web server. The default database instance is called "default". A debconf facility is provided for configuring several redmine instances. Use dpkg-reconfigure to define the instances identifiers. NOTICE : every rake command has to know which instance it applies to. TO SELECT THE INSTANCE, USE X_DEBIAN_SITEID= BEFORE ANY RAKE TASK. Example : (run the imap mail receiver) sudo -u www-data X_DEBIAN_SITEID=default RAILS_ENV=production \ rake -f /usr/share/redmine/Rakefile \ redmine:email:receive_imap \ host=imap.test.com \ username=test@test.com password=xxxxxx REDMINE GUIDE ------------- http://www.redmine.org/wiki/redmine/Guide REMEMBER TO CHANGE THE DEFAULT ADMIN PASSWORD --------------------------------------------- By default, redmine admin account log/pass is admin/admin MANUAL WEB SERVER CONFIGURATION ------------------------------- There are several ways to serve a rails app like redmine. Some examples for configuration with passenger, or with a fastcgi web server, are available in /usr/share/doc/redmine/examples. To run redmine with a fastcgi web server, libfcgi-ruby package must be installed. Also note that libapache2-mod-fcgid package provides fastcgi support for apache2. In the provided examples, the environment variable must be set to the desired instance name : X_DEBIAN_SITEID= By default, X_DEBIAN_SITEID=default QUICK LAUNCH USING WEBRICK -------------------------- To test redmine without installing a web server, run as root : cd /usr/share/redmine/ mkdir tmp chown www-data:www-data tmp mkdir log touch log/production.log chown www-data:www-data log/production.log sudo -u www-data X_DEBIAN_SITEID="default" ruby script/server webrick -e production and point your browser to http://localhost:3000 When done, remove /usr/share/redmine/tmp NOTICE : * Running without sudoing to www-data will change permissions on some files, e.g. /var/log/redmine files. Fix it or reinstall the redmine package if you did so. * The tmp/ directory is needed when launching webrick, although nothing but empty directories will be created in it. OWNERS AND PERMISSIONS ---------------------- It is assumed ruby will run redmine as www-data:www-data. Accordingly, these files are owned by root:www-data and have 640 permissions : /etc/redmine//session.yml /etc/redmine//database.yml /etc/redmine//email.yml These folders are owned by www-data:www-data and have 750 permissions : /var/log/redmine/* /var/lib/redmine/* /var/cache/redmine/* Relaxing those permissions is discouraged. Please think twice before doing so. If one really need to run redmine as another user, please read what follows. MANUAL INSTALL / RUNNING AS UNPRIVILEGED USER WITHOUT COPYING /usr/share/redmine -------------------------------------------------------------------------------- Why : redmine package upgrades will benefit to all redmine instances, although calling manually rake db:migrate on each package upgrade is still necessary. Besides support for X_DEBIAN_SITEID, several environment variables are available : * RAILS_ETC (where database.yml, email.yml are supposed to be) * RAILS_LOG (the log files) * RAILS_VAR (contains the files/ directory) * RAILS_CACHE (cached data) * RAILS_ENV That way, one can install redmine as a user foo : 1. First create some directories in e.g. /home/foo/redmine : config, files, tmp, log 2. In a terminal, declare those environment variables : mydir=/home/dev/test/redmine export RAILS_ETC=$mydir/config export RAILS_LOG=$mydir/log export RAILS_VAR=$mydir export RAILS_CACHE=$mydir/tmp export RAILS_ENV=production export X_DEBIAN_SITEID=myinstance 3. Copy /usr/share/redmine/templates/database.yml.template to $mydir/config/database.yml and adapt it to your needs; for a quick setup it's easier to use the sqlite template, located in the same dir. 4. Link /usr/share/redmine/db to $mydir/db : ln -s /usr/share/redmine/db $mydir/db 5. Then "install" redmine : rake -f /usr/share/redmine/Rakefile generate_session_store rake -f /usr/share/redmine/Rakefile db:migrate rake -f /usr/share/redmine/Rakefile redmine:load_default_data rake -f /usr/share/redmine/Rakefile db:migrate_plugins 6. Run redmine using e.g. webrick and point your browser to localhost:3000 ruby /usr/share/redmine/script/server webrick -e production MANUAL EMAIL CONFIGURATION -------------------------- Email settings are not automatically configured, for a quick setup : cp /usr/share/doc/redmine/examples/email.yml /etc/redmine//email.yml and edit the file. Then change permissions and owner : chmod 640 /etc/redmine//email.yml chown root:www-data /etc/redmine//email.yml then restart redmine and check if it's working by sending a test email in Administration panel -> Settings -> Email notifications -> Send a test email or refer to the Redmine Guide. WARNING : delivery_method: :async_smtp -------------------------------------- It has been reported [0] that this method does not work when used by a rake task (e.g. in a crontab). Simply use :smtp method in that case. [0] http://bugs.debian.org/cgi-bin/bugreport.cgi?bug=570402 -- Jérémy Lal Sat, 19 Sep 2009 14:30:19 +0200