Bitnami Redmine 3.4.4-1¶

setup receiving email¶

add following shell-script to /usr/local/bin/redmine_recv_mail.sh

#to make this work I also had to do following things:
#
#  cd /opt/redmine-2.5.2-2
#  ./use_redmine
#  gem install rake -v 10.1.1
#
#add following file to 

PATH="/opt/redmine-3.4.4-1/perl/bin:/opt/redmine-3.4.4-1/git/bin:/opt/redmine-3.4.4-1/sqlite/bin:/opt/redmine-3.4.4-1/ruby/bin:/opt/redmine-3.4.4-1/subversion/bin:/opt/redmine-3.4.4-1/postgresql/bin:/opt/redmine-3.4.4-1/php/bin:/opt/redmine-3.4.4-1/mysql/bin:/opt/redmine-3.4.4-1/apache2/bin:/opt/redmine-3.4.4-1/common/bin:$PATH" 
BITNAMI_ROOT="/opt/redmine-3.4.4-1" 
export BITNAMI_ROOT

cd /opt/redmine-3.4.4-1/apps/redmine/htdocs
bundle exec rake redmine:email:receive_imap RAILS_ENV="production" ssl=true host=mail.example.com port=993 username=redmine@example.com password=mySecret4711 unknown_user=create no_permission_check=1

this setup will accept mails from everyone and automagically register unknown users.

add following cron-file /etc/cron.d/redmine_mail_recv

 */15 * * * * root /usr/local/bin/redmine_recv_mail.sh

if you get an error about SSL-certificate (self signed) you may bypass SSL-verify by adding this file to /opt/redmine-3.4.4-1/apps/redmine/htdocs/config/initializers/avoid_ssl_verification.rb

    require 'openssl'
    OpenSSL::SSL::VERIFY_PEER = OpenSSL::SSL::VERIFY_NONE

Troubleshoot imap¶

if you did the above change, then this shouldn't be necessary. For me this is giving me
/opt/redmine-3.4.4-1/apps/redmine/htdocs/config/initializers/avoid_ssl_verification.rb:4: warning: already initialized constant OpenSSL::SSL::VERIFY_PEER therefore I go for the change below.

change /opt/redmine-3.4.4-1/ruby/lib/ruby/2.3.0/net/imap.rb line ~1456

    def create_ssl_params(certs = nil, verify = true)
      params = {}
      if certs
        if File.file?(certs)
          params[:ca_file] = certs
        elsif File.directory?(certs)
          params[:ca_path] = certs
        end
      end
      if verify
      #  params[:verify_mode] = VERIFY_PEER
      #  taken out by JKE 2015-07-06
        params[:verify_mode] = VERIFY_NONE
      else
        params[:verify_mode] = VERIFY_NONE
      end
      return params
    end

setup log-rotating¶

Redmine¶

The Bitnami-Stack does not preconfigure log-rotating for the production.log located in /opt/redmine-3.4.4-1/apps/redmine/htdocs/log. Although you could use the standard Logrotate it's recommended (http://www.redmine.org/boards/2/topics/11836) to use the Ruby-functionality. Add following parameter to /opt/redmine-3.4.4-1/apps/redmine/htdocs/config/environments/production.rb and restart the Bitnami-Stack.

According to http://www.redmine.org/issues/11603 you have to provide a file directly to Logger.new instead of the sample in the production.rb.

# 7 log-files, 20MB each
config.logger = Logger.new('/opt/redmine-3.0.3-0/apps/redmine/htdocs/log/production.log', 7, 20971520)
config.logger.level = Logger::INFO

[root@redmine ~]# cd /opt/redmine-3.4.4-1/apps/redmine/htdocs/log/
[root@redmine log]# ll
total 1120
-rwxrwxr-x. 1 root   daemon      36 Jun 18  2012 delete.me
-rw-r--r--. 1 daemon daemon   12158 Jul  9 09:36 production.log
-rw-rw-r--. 1 root   daemon   30053 Jul  9 09:28 production.log.0
-rwxrwxr-x. 1 root   daemon 1093571 Jul  9 08:59 production.log.1

apache / mysql¶

let's use logrotate for this task. There is .conf-files already shipped with the bitnami-stack.
https://docs.bitnami.com/installer/components/logrotate/

ln -s /opt/redmine-3.4.4-1/config/logrotate/logrotate.d/apache.conf /etc/logrotate.d/bitnami_3.4.4-1_apache.conf
ln -s /opt/redmine-3.4.4-1/config/logrotate/logrotate.d/mysql.conf /etc/logrotate.d/bitnami_3.4.4-1_mysql.conf

setup Redmine-Logo¶

http://www.redmine.org/projects/redmine/wiki/Howto_add_a_logo_to_your_Redmine_banner

edit following file /opt/redmine-3.4.4-1/apps/redmine/htdocs/app/views/layouts/base.html.erb

#line 44
<h1><img src="<%= Redmine::Utils.relative_url_root %>/images/logo.png" style="top-margin: 15px; left-margin: 15px;"/> <%= page_header_title %></h1>

copy logo.png to /opt/redmine-3.4.4-1/apps/redmine/htdocs/public/images

setup service¶

add following service-unit /etc/systemd/system/bitnami-redmine.service

[Unit]
Description=run bitnami redmine
After=network.target

[Service]
Type=oneshot
RemainAfterExit=yes
ExecStart=/opt/redmine-3.4.4-1/ctlscript.sh start
ExecStop=/opt/redmine-3.4.4-1/ctlscript.sh stop

[Install]
WantedBy=multi-user.target

enable the unit by

systemctl enable bitnami-redmine

Nagging¶

There are a couple of plugins available, we are trying to do our own thing.

create a read only user¶

mysql -u root -p
grant select on bitnami_redmine.* to 'redmine_reader'@'localhost';

create a sql-statement¶

http://www.redmine.org/projects/redmine/wiki/DatabaseModel

This statement lists all open issues from the project with the internal ID 33 and all sub-projects with a due-date earlier than today+7days. All issue-IDs will be click-able links in the nag-mail.

SELECT CONCAT('@@@1@http://www.example.com/redmine/issues/',_i.id,'@@@2@',_i.id,'@@@3@') AS ID,_is.name AS STATUS,_p.name AS Projekt ,LEFT(_i.subject,100) AS Thema,_i.due_date AS Zieldatum, _e.address AS mail
FROM (SELECT DISTINCT _b.id,_b.name 
      FROM (SELECT _p.name,_p.id 
            FROM projects AS _p 
            WHERE _p.id=33 OR _p.parent_id=33
           ) AS pp, projects AS _b 
      WHERE _b.parent_id=pp.id OR _b.id=33 ORDER BY _b.name
     ) AS _p,
     issues AS _i, 
     issue_statuses AS _is , 
     users AS _u,
     email_addresses AS _e
WHERE _p.id = _i.project_id 
  AND _i.status_id=_is.id 
  AND _u.id=_i.assigned_to_id 
  AND _u.id=_e.user_id 
  AND _is.is_closed=0 
  AND _i.due_date<=ADDDATE(curdate(),7) 
ORDER BY _p.name,_i.id;

the funny @@n groups are used later on.

create a html-mail¶

create a little shell-sript redmine_send_mail.sh that

• fetches the data from the database
• forms a valid html-mail
• sends the mail to one recipient

#!/bin/sh

PATH="/opt/redmine-3.4.4-1/perl/bin:/opt/redmine-3.4.4-1/git/bin:/opt/redmine-3.4.4-1/sqlite/bin:/opt/redmine-3.4.4-1/ruby/bin:/opt/redmine-3.4.4-1/subversion/bin:/opt/redmine-3.4.4-1/postgresql/bin:/opt/redmine-3.4.4-1/php/bin:/opt/redmine-3.4.4-1/mysql/bin:/opt/redmine-3.4.4-1/apache2/bin:/opt/redmine-3.4.4-1/common/bin:$PATH" 

#export List from DB
mysql -u redmine_reader -H -B bitnami_redmine < list.sql > /tmp/redmine_mysql_output

#replace special stuff
sed -i -e 's/@@@1@/<a href="/g' /tmp/redmine_mysql_output
sed -i -e 's/@@@2@/">/g' /tmp/redmine_mysql_output
sed -i -e 's/@@@3@/<\/a>/g' /tmp/redmine_mysql_output

echo 'Subject: weekly audit "all open issues due within the next 7 days"' > /tmp/redmine_mail_raw
echo 'to: user@example.com' >> /tmp/redmine_mail_raw
echo 'MIME-Version: 1.0' >> /tmp/redmine_mail_raw
echo 'Content-Type: text/html; charset=utf-8' >> /tmp/redmine_mail_raw

echo '' >> /tmp/redmine_mail_raw
echo '<html>' >> /tmp/redmine_mail_raw
echo '<meta http-equiv="Content-Type" content="text/html; charset=utf-8">' >> /tmp/redmine_mail_raw

#export List from DB
cat /tmp/redmine_mysql_output >> /tmp/redmine_mail_raw
echo '</html>' >> /tmp/redmine_mail_raw

#send mail
cat /tmp/redmine_mail_raw | sendmail -t

use cron to nag periodically¶

run the shell-script from above every monday at 8:00am. /etc/cron.d/redmine_audit

# JKE 2014-10-22
#
# minute hour day month dayofweek
# m h d m d
# - - - - -
# | | | | |
# | | | | +-day of week (0-7) sunday=0 or 7
# | | | +---month (1-12)
# | | +-----day of month (1-31)
# | +-------hour (0-23)
# +---------min (0-59)
# 
    00    08    *    *    1    root    /usr/local/bin/redmine_send_mail.sh