概要¶
Redmineにはデフォルトでチケットの期日まで何日かメールで通知する機能が備わっています。
これにより、
- 作成したチケットの処理忘れを防ぐ
- 定期作業など、開始日が定まっているチケットを事前に把握する
ことが可能になります。
本記事では、この機能を有効化するとともに、これに必要なLinuxサーバの設定についても記します。
環境¶
以下の環境で動いていることを確認しています。
- Ubuntu 20.04系Linux
- Redmine 4.2
前提¶
この作業の前に、以下が必須です。
- Redmineでメール通知が有効になっていること
- (Gmailとの連携方法については以下で案内しています)
- https://atelier.reisalin.com/projects/zettel/knowledgebase/articles/22
実施した手順¶
本作業はRedmineのWeb上で作業をしません。全て稼働サーバのSSHで操作を行います。
さっくりとした手順¶
- Linuxのrsyslog設定でcronログを有効にします。
- リマインダースクリプトを作成して実行権限を付与します。
- cronで定期実行されるようにします。
rsyslogdでCronログの有効化¶
設定ファイルのバックアップ取得¶
sudo cp -pi /etc/rsyslog.d/50-default.conf /path/to/backup/directory/50-default.conf.$(date +%Y%m%d)
diff -u /etc/rsyslog.d/50-default.conf /path/to/backup/directory/50-default.conf.$(date +%Y%m%d)
# 差分が無いことでバックアップが取れていることを確認します。
設定ファイルの書き換え¶
sudo sed -i 's/^#cron.*/cron.* \/var\/log\/cron.log/' /etc/rsyslog.d/50-default.conf
- ○差分確認
diff -u /path/to/backup/directory/50-default.conf.$(date +%Y%m%d) /etc/rsyslog.d/50-default.conf
- ●差分
-#cron.* /var/log/cron.log
+cron.* /var/log/cron.log
rsyslogd反映¶
systemctl status rsyslog.service
# active (running)を確認します
sudo systemctl restart rsyslog.service
systemctl status rsyslog.service
# active (running)を確認します
リマインダースクリプトの作成¶
スクリプト格納ディレクトリを作成して移動します。¶
mkdir /home/hoge/scripts
# ログインユーザー名配下がメンテナンスしやすいです
cd /home/hoge/scripts && pwd
# 作成したディレクトリにいることを確認します
リマインダースクリプトを作成します。¶
【】内は自分の環境に合わせ、書き換えてからコマンドを実行します。（詳細をコメントで書いています）
cat <<- __EOF__ | tee -a redmine_reminder_3days.sh
#!/bin/sh
SHELL=/bin/sh
PATH=/usr/local/sbin:/usr/local/bin:/sbin:/bin:/usr/sbin:/usr/bin
cd 【/var/lib/redmine】
# 自分が格納しているRedmineのルートディレクトリ
bundle exec rake redmine:send_reminders days=3 RAILS_ENV=production
# この例では3日前に通知します。days=nの部分を変えることで日数を指定できます
__EOF__
筆者は、
- 1日前 (redmine_reminder_1day.sh)
- 3日前 (redmine_reminder_3days.sh)
- 7日前 (redmine_reminder_7days.sh)
- 31日前 (redmine_reminder_31days.sh)
の4種類を作成し、それぞれの期日にメールを送付するようにしています。
スクリプトに実行権限を付与し、動作を確認します。¶
- ★実行権付与
chmod +x redmine_reminder_*day*.sh
ls -l redmine_reminder_*day*.sh
# 実行権限がついていることを確認します
- ★動作確認
sudo -u www-data sh /home/hoge/scripts/redmine_reminder_3days.sh
# warningは今のところは無視して大丈夫です
締め切りが3日に到来するチケット一覧のメールが受信されれば成功です。
crontabに追加¶
現行のcrontab確認¶
sudo crontab -l -u www-data
- ●結果確認
no crontab for www-data
と出ていることを確認します。
crontab追記¶
sudo crontab -e -u www-data
- ※注意事項
初めてこのコマンドを実行した場合、「crontabで用いるエディタは何か」を確認されます。自分の信仰や教義に合わせたエディタを選択してください。
追記例¶
20 8 * * * /home/hoge/scripts/redmine_reminder_31days.sh
30 8 * * * /home/hoge/scripts/redmine_reminder_1day.sh
30 16 * * * /home/hoge/scripts/redmine_reminder_7days.sh
40 16 * * * /home/hoge/scripts/redmine_reminder_1day.sh
20 20 * * * /home/hoge/scripts/redmine_reminder_3days.sh
30 20 * * * /home/hoge/scripts/redmine_reminder_1day.sh
この例では、
- 8:20 → 31日前に期日が到来する担当チケット
- 8:30 → 1日前に期日が到来する担当チケット
- 16:30 → 7日前に期日が到来する担当チケット
- 16:40 → 1日前に期日が到来する担当チケット
- 20:20 → 3日前に期日が到来する担当チケット
- 20:30 → 1日前に期日が到来する担当チケット
をそれぞれ通知します。
追記確認¶
- ★crontab 追記確認
sudo crontab -l -u www-data
追記した内容があることを確認します。
- ★cronログ 設定確認
cat /var/log/cron.log
- BEGIN EDIT (www-data)
- REPLACE (www-data)
- END EDIT (www-data)
が、crontabに追記した時間帯にあれば設定完了です。
後は、指定した時間にメールが通知されることを待ちましょう。(キチッと確認したい場合は、cronの実行時刻を調整してください)
