Redmineプラグイン

Redmineの機能を拡張するプラグインについて

AdditionalプラグインをRedmine4.2にインストール

概要

Redmineにかなり強力なmacroを付与するプラグイン:additionalsをインストールします。

また、このプラグインは「additonal_tags」プラグインでも必要です。

プラグイン名

Additionals

https://www.redmine.org/plugins/additionals

前提

新バージョンはRedmine 5.xから対応しているため、今利用しているRedmine4.2で動かすためには少し作業が必要です。

動作を確認した環境

Redmine 4.2

導入時

手順

さっくりとした手順

  1. SSHログイン後、作業ディレクトリに移動
  2. wgetでRedmine4.2に即したパッケージをダウンロード
  3. パッケージの配置
  4. 新規ジェムをインストール
  5. DBマイグレーション
  6. Webサービス再起動

作業用ディレクトリに移動します。

cd /hoge

任意のディレクトリに移動します

Redmine4.2に即したバージョンをダウンロードして展開します。

wget https://github.com/AlphaNodes/additionals/archive/refs/tags/3.0.5.2.zip
unzip 3.0.5.2.zip
sudo chown -R www-data:www-data additionals-3.0.5.2

apache / nginxの実行ユーザに所有者を合わせます

Redmineディレクトリにプログラムを配置します。

sudo mv additionals-3.0.5.2 /var/lib/redmine/plugins/additionals

自分の環境に合わせます。また、ディレクトリ名からバージョン名を外すのを忘れないようにしてください

Redmineのルートディレクトリに移動します。

cd /var/lib/redmine&& pwd

自分の環境に合わせます。

Gemをインストールします。

sudo -u www-data bundle install

DBのマイグレーションを行います

sudo -u www-data bundle exec rake redmine:plugins:migrate RAILS_ENV=production

Webサービスを再起動します。

sudo systemctl restart apache2

動作

  1. Redmineに管理者アカウントでログインします。
  2. 管理に「Additionals」が加わっていればインストールされています。

Additional TagsプラグインをRedmine 4.2にインストール

概要

チケットのタグ付けを行い、各チケットの横断的な検索を可能にします。

プラグイン名

動作を確認した環境

Redmine 4.2

前提:

導入時

手順

Redmine_Tagsを導入済みの場合は、バックアップを取り、失敗時に復旧できる準備をすることを強く推奨します。

さっくりとした手順

  1. SSHログイン後、作業ディレクトリに移動
  2. wgetでRedmine4.2に即したパッケージをダウンロード
  3. パッケージの配置
  4. 旧プラグインのディレクトリ削除
  5. 新規ジェムをインストール
  6. DBマイグレーション
  7. Webサービス再起動

作業用ディレクトリに移動します。

cd /hoge && pwd

任意のディレクトリを指定します。

Redmine4.2に即したバージョンをダウンロードして展開します。

wget https://github.com/AlphaNodes/additional_tags/archive/refs/tags/1.0.4.zip

リリースノートで、Redmine 4.2に対応したバージョンがこれでした

unzip 1.0.4.zip
sudo chown -R www-data:www-data additional_tags-1.0.4/

apache / nginxの実行ユーザに所有者を合わせます

Redmineディレクトリにプログラムを配置します。

sudo mv  additional_tags-1.0.4 /home/www-data/redmine/plugins/additional_tags

自分の環境に合わせます。また、ディレクトリ名からバージョン名を外すのを忘れないようにしてください

(オプション)インストール済みのRedmine_Tagsディレクトリを削除します。

※新規インストールの場合はこの作業は不要です

cd /home/www-data/redmine/plugins && pwd

自分の環境に合わせます。

ls -ld additional_tags redmine_tags

2つのディレクトリがあることを確認します

sudo rm -rf redmine_tags
ls -ld additional_tags redmine_tags

additonal_tagsのみがあることを確認します

Redmineのルートディレクトリに移動します。

cd /home/www-data/redmine/

自分の環境に合わせます

Gemをインストールします

sudo -u www-data bundle install

DBのマイグレーションを行います

sudo -u www-data bundle exec rake redmine:plugins:migrate RAILS_ENV=production

Webサービスを再起動します。

sudo systemctl restart apache2

インストール後の動作

  1. Redmineに管理者アカウントでログインします。
  2. 管理に移動すると、「Tags」メニューが追加されているのでクリックして移動します。
  3. 以下の設定を行います。
    • サイトバーにタグを:シンプルなクラウド
    • タグに金額を表示(※Totalがこう和訳されています):チェック
    • 課題タグを有効にする:チェック
  4. Redmine_tagから移行している場合は、「タグの管理」タブで記載されたタグがあることを確認します。

Redmineプラグイン『Kanban』のインストール

概要

チケットをかんばん形式に表示するプラグインをインストールします。

これによって、

を一瞥することができるようになります。

プラグイン名

動作を確認した環境

導入時

Gem追加:不要 DBマイグレーション:不要

手順

さっくりとした手順

  1. SSHログイン後、Redmineプラグインに移動
  2. gitでレポジトリをダウンロード
  3. Webサービス再起動

Redmineのプラグインディレクトリに移動します。

cd /home/www-data/redmine/plugins

自分の環境に合わせます。

プラグインを配置します。

sudo -u www-data git clone https://github.com/happy-se-life/kanban
ls -ld kanban

このディレクトリがあることを確認します

Webサービスを再起動します。

sudo systemctl restart apache2

インストール後の設定

  1. Redmineに管理者アカウントでログインします。
  2. 任意のプロジェクトを選択して設定をクリックします。
  3. モジュール「kanban」にチェックを入れて保存します。
  4. このように、チケット一覧がかんばん形式で表示されていれば設定完了です。

Redmica_UI_Extensionのインストール

概要

Redmineの使い勝手を高めてくれるプラグインをインストールします。

プラグイン名

動作を確認した環境

導入時

手順

さっくりとした手順

  1. SSHログイン後、Redmineプラグインに移動
  2. gitでレポジトリをダウンロード
  3. Webサービス再起動

ディレクトリに移動します。

cd /var/lib/redmine/plugins
# 自分の環境に合わせます。

プラグインを配置します。

sudo -u www-data git clone https://github.com/redmica/redmica_ui_extension.git
ls -ld redmica_ui_extension

このディレクトリがあることを確認します

Redmineのルートディレクトリに移動します。

cd /home/www-data/redmine/

自分の環境に合わせます

Gemをインストールします

sudo -u www-data bundle install

Webサービスを再起動します。

sudo systemctl restart apache2

動作

が確認できればインストールできています。

詳細は

https://blog.redmine.jp/articles/redmica-ui-extension-plugin/

を参照してください。

Redmine4.2にKnowledgebaseプラグインをインストール(及びプログラム修正)

概要

各種文書やファイルをカテゴリー/タグで分類し、各種ナレッジ/Tipsを整理するプラグイン、knowledgeをインストールし、設定します。

Githubでは、Redmine4.xに対応しているバージョンのみがリリースされています
→ 5.x系でのブランチを確認しました。

プラグイン名

動作を確認した環境

Redmine 4.2

導入時

手順

さっくりとした手順

  1. SSHログイン後、Redmineプラグインに移動
  2. gitでレポジトリをダウンロード
  3. 新規ジェムをインストール
  4. 設定ファイル修正
  5. DBマイグレーション
  6. Webサービス再起動

ディレクトリに移動します。

cd /home/www-data/redmine/plugins
# 自分の環境に合わせます。

プラグインを配置します。

sudo -u www-data git clone https://github.com/alexbevi/redmine_knowledgebase
ls -ld redmine_knowledgebase/

このディレクトリがあることを確認します

プラグインの修正を行います。(1-links.htmlの退避)

この処理を行わないと、ファイルの添付ができません

cd redmine_knowledgebase/app/views/attachments/
sudo mv _links.html.erb ../_links.html.erb.$(date +%Y%m%d)

プラグインの修正を行います。(2-設定ファイルの書き換え)

この処理を行わないと、ファイル添付後にInternal Server Errorが発生します。

cd /home/www-data/redmine/plugins/redmine_knowledgebase/app/helpers && pwd

/pluginsまでは自分の環境に合わせます。

sudo cp -pi knowledgebase_helper.rb /path/to/backup/path/knowledgebase_helper.rb.$(date +%Y%m%d)
diff -u knowledgebase_helper.rb /path/to/backup/path/knowledgebase_helper.rb.$(date +%Y%m%d)

差分が無いことでバックアップが取れていることを確認します。

sudo -u www-data sed -i 's/return "#{Setting.protocol}:\/\/#{Setting.host_name}#{thumbnail_path(thumb)}"/return polymorphic_url(thumb, :host => Setting.host_name, :protocol => Setting.protocol)/g' knowledgebase_helper.rb
diff -u /path/to/backup/path/knowledgebase_helper.rb.$(date +%Y%m%d) knowledgebase_helper.rb
     thumb = get_article_thumbnail( article )
 
     if thumb
-      return "#{Setting.protocol}://#{Setting.host_name}#{thumbnail_path(thumb)}"
+      return polymorphic_url(thumb, :host => Setting.host_name, :protocol => Setting.protocol)
     else
       return ''

Redmineのルートディレクトリに移動します。

cd /home/www-data/redmine

Gemをインストールします

sudo -u www-data bundle install

DBのマイグレーションを行います

sudo -u www-data bundle exec rake redmine:plugins:migrate RAILS_ENV=production

Webサービスを再起動します。

sudo systemctl restart apache2

動作後の確認

  1. Redmineに管理者アカウントでログインします。
  2. 任意のプロジェクトを選択して設定をクリックします。
  3. モジュール「knowledge」にチェックを入れて保存します。
  4. このように、プロジェクトにナレッジベースのタブが表示されていれば設定完了です。

Redmine 5.xにknowlegebaseをインストール。

筆者にとってRedmineのキラーアプリだったknowlegebase。その5.x対応版が出たので導入を行います。

https://github.com/yzzy/redmine_knowledgebase

環境

導入時

※Redmine 4.2で実施した設定ファイルの退避や修正は不要でした。

さっくりとした手順

  1. SSHログイン後、Redmineプラグインに移動
  2. gitでレポジトリをダウンロード
  3. 新規ジェムをインストール
  4. DBマイグレーション
  5. Webサービス再起動

ディレクトリに移動します。

cd /home/www-data/redmine/plugins && pwd

自分の環境に合わせます。

プラグインを配置します。

sudo -u www-data git clone https://github.com/yzzy/redmine_knowledgebase
ls -ld redmine_knowledgebase/

このディレクトリがあることを確認します

Gemをインストールします。

cd /home/www-data/redmine && pwd

自分の環境に合わせます。

sudo -u www-data bundle install

DBのマイグレーションを行います。

cd /home/www-data/redmine && pwd

自分の環境に合わせます。

sudo -u www-data bundle exec rake redmine:plugins:migrate RAILS_ENV=production

Webサービスを再起動します。

sudo systemctl restart apache2

動作後の確認

  1. Redmineに管理者アカウントでログインします。
  2. 任意のプロジェクトを選択して設定をクリックします。
  3. モジュール「knowledge」にチェックを入れて保存します。
  4. このように、プロジェクトにナレッジベースのタブが表示されていれば設定完了です。

Redmine 4.2にIssue_Badge_Pluginをインストール

概要

自分が担当しているチケット数を目の当たりにするプラグインをインストールします。

「Redmineはみんなでチケットを消すゲーム」

と開発者がスライドで述べているとおり、この、チケット数の把握はとても重要です。

https://www.slideshare.net/g_maeda/redmine-33993601

※Redmine 4.xをサポートしているバージョンをダウンロードして展開するため、作業が一手間あります。

プラグイン名

Redmine Issue Badge

動作を確認した環境

Redmine 4.2

導入時

手順

さっくりとした手順

  1. SSHログイン後、Redmineプラグインに移動
  2. gitでプログラムをダウンロード
  3. プログラムを配置
  4. 新規ジェムをインストール
  5. DBマイグレーション
  6. Webサービス再起動

作業用ディレクトリに移動します。

cd /hoge && pwd

任意のディレクトリを指定します。

Redmine 4.xに対応したプログラムを入手します。

wget https://github.com/akiko-pusu/redmine_issue_badge/archive/refs/tags/v0.1.0.zip
unzip v0.1.0.zip
sudo chown -R www-data:www-data redmine_issue_badge-0.1.0

プラグインディレクトリをRedmineのプラグインディレクトリに移動します。

sudo mv redmine_issue_badge-0.1.0 /home/www-data/redmine/plugins/redmine_issue_badge

配置先は自分の環境に合わせます。また、バージョン名も取り除きます。

Redmineのルートディレクトリに移動します。

cd /home/www-data/redmine && pwd

自分の環境に合わせます。

Gemをインストールします

sudo -u www-data bundle install

DBのマイグレーションを行います

sudo -u www-data bundle exec rake redmine:plugins:migrate RAILS_ENV=production

Webサービスを再起動します。

sudo systemctl restart apache2

動作

  1. 管理者アカウントでログインします。
  2. 管理 > プラグイン > Redmine Issue Badge plugin > 設定をクリックします。
  3. 全てにチェックを入れて「保存」をクリックします。
  4. 自分に割り当てられているチケット数が表示されれば設定完了です。

Redmine 5.xにIssue_Badge_Pluginをインストール

概要

自分が担当しているチケット数を目の当たりにするプラグインをインストールします。

「Redmineはみんなでチケットを消すゲーム」

と開発者がスライドで述べているとおり、この、チケット数の把握はとても重要です。

https://www.slideshare.net/g_maeda/redmine-33993601

プラグイン名

Redmine Issue Badge

動作を確認した環境

Redmine 5.1

導入時

手順

さっくりとした手順

  1. SSHログイン後、Redmineプラグインに移動
  2. gitでレポジトリをダウンロード
  3. 新規ジェムをインストール
  4. DBマイグレーション
  5. Webサービス再起動

Redmineプラグインディレクトリに移動します。

cd /home/www-data/redmine/plugins

プラグインを配置します。

sudo -u www-data git clone https://github.com/akiko-pusu/redmine_issue_badge
ls -ld redmine_issue_badge

このディレクトリがあることを確認します

Redmineルートディレクトリに移動します。

cd /home/www-data/redmine && pwd

自分の環境に合わせます。

Gemをインストールします

sudo -u www-data bundle install

DBのマイグレーションを行います


sudo -u www-data bundle exec rake redmine:plugins:migrate RAILS_ENV=production

Webサービスを再起動します。

sudo systemctl restart apache2

動作

  1. 管理者アカウントでログインします。
  2. 管理 > プラグイン > Redmine Issue Badge plugin > 設定をクリックします。
  3. 全てにチェックを入れて「保存」をクリックします。
  4. 自分に割り当てられているチケット数が表示されれば設定完了です。

Redmine4.2(5.x)にIssue_Template_Pluginをインストール

概要

状況下で大いに役立つプラグインです。

そして、その状況は「常に」発生します。ゆえに、このプラグインは必須と言い切ります。

プラグイン名

動作を確認した環境

導入時

Gem追加:要 DBマイグレーション:要

手順

さっくりとした手順

  1. SSHログイン後、Redmineプラグインに移動
  2. gitでレポジトリをダウンロード
  3. 新規ジェムをインストール
  4. DBマイグレーション
  5. Webサービス再起動

Redmineのプラグインディレクトリに移動します。

cd /home/www-data/redmine/plugins

プラグインを配置します。 (Redmine 4.2の場合)

sudo -u www-data git clone https://github.com/akiko-pusu/redmine_issue_templates
ls -ld redmine_issue_templates

プラグインを配置します。 (Redmine 5.1の場合)

sudo -u www-data git clone https://github.com/agileware-jp/redmine_issue_templates
ls -ld redmine_issue_templates

Redmineルートディレクトリに移動します。

cd /home/www-data/redmine && pwd

自分の環境に合わせます。

Gemをインストールします。

sudo -u www-data bundle install

DBのマイグレーションを行います。

sudo -u www-data bundle exec rake redmine:plugins:migrate RAILS_ENV=production

Webサービスを再起動します。

sudo systemctl restart apache2

動作

  1. Redmineに管理者アカウントでログインします。
  2. 任意のプロジェクトを選択して設定をクリックします。
  3. モジュール「チケットテンプレート」にチェックを入れて保存します。
  4. プロジェクトにチケットテンプレートのタブが表示されていれば設定完了です。

Redmine4.2に markdown Task Listプラグインのインストール。

概要

マークダウンでチェックリストを作成するプラグインです。

- [ ] チェックリスト

という表記すると、

に変えてくれます。チェック済みの場合は

- [x] チェックリスト

と記入します。

地味ですけれどもチケット内に気軽にチェックを作れるので多用しています。

※5.1ではビルトインされているため、このプラグインは不要です。

プラグイン名

Redmine Markdown Task List Plugin

動作を確認した環境

Redmine 4.2

導入時

手順

さっくりとした手順

  1. SSHログイン後、Redmineプラグインに移動
  2. gitでレポジトリをダウンロード
  3. Webサービス再起動

Redmineプラグインディレクトリに移動します。

cd /home/www-data/redmine/plugins
# 自分の環境に合わせます。

プラグインを配置します。

sudo -u www-data git clone https://github.com/eichisanden/redmine_markdown_task_list
ls -ld redmine_markdown_task_list

このディレクトリがあることを確認します

Webサービスを再起動します。

sudo systemctl restart apache2

動作

任意のチケット、コメント、Wikiなどで

- [ ]

を入力して保存後、チェックボックスになっていることを確認します。

- [x]

とすることで、チェックをクローズできます。

Redmine shortcustのインストール(キーボードショートカットで操作できるプラグイン)

概要

チケットの編集をEキー、文字列を選択した後にCtrl + Bで強調表示にするなど、エディタ感覚でチケット管理を行えるプラグインをインストールします。

プラグイン名

動作を確認した環境

導入時

さっくりとした手順

  1. SSHログイン後、Redmineプラグインに移動
  2. gitでレポジトリをダウンロード
  3. Webサービス再起動

Redmineプラグインディレクトリに移動します。

cd /home/www-data/redmine/plugins

自分の環境に合わせます。

プラグインを配置します。

sudo -u www-data git clone https://github.com/davidegiacometti/redmine_shortcuts
ls -ld redmine_shortcuts

このディレクトリがあることを確認します

Webサービスを再起動します。

sudo systemctl restart apache2

動作

  1. ヘッダー上部に「Redmine shortcuts」が表示される
  2. チケット詳細画面で「E」を入力することでチケット編集画面に遷移できる

が確認できればインストールできています。

Redmine View Customizeのインストール。

概要

このView Customize Pluginは言うなれば「Redmineにおけるアーミーナイフ」です。

Redmine上の

など、細かい修正をGUI上で行うことができます。しかも、ここで行った修正自体がRedmineのDBに保存されるため、他のサイトへの移設やバージョンアップ時にもソースをいじることがありません。

プラグイン名

動作を確認した環境

導入時

手順

さっくりとした手順

  1. SSHログイン後、Redmineプラグインに移動
  2. gitでレポジトリを「リネームして」ダウンロード
  3. 新規ジェムをインストール
  4. DBマイグレーション
  5. Webサービス再起動

Redmineプラグインディレクトリに移動します。

cd /home/www-data/redmine/plugins && pwd

プラグインを配置します。ついでにリネームを行います。

sudo -u www-data git clone https://github.com/onozaty/redmine-view-customize.git view_customize

リポジトリ名は「redmine-view-customize」ですが、システム名称が「view_customize」です。単純ですがハマりやすいポイントです。

ls -ld view_customize

このディレクトリがあることを確認します

Redmineルートディレクトリに移動します。

cd /home/www-data/redmine && pwd

自分の環境に合わせます。

Gemをインストールします

sudo -u www-data bundle install

DBのマイグレーションを行います。

sudo -u www-data bundle exec rake redmine:plugins:migrate RAILS_ENV=production

Webサービスを再起動します。

sudo systemctl restart apache2

動作

  1. Redmineに管理者アカウントでログインします。
  2. 管理>表示のカスタマイズと表示されれば設定完了です。

メンテナによるサンプルがありますので、こちらを参考に設定していきます。

https://github.com/onozaty/redmine-view-customize-scripts

Redmine4.2にRedmine_Issue_Importerをインストール

概要

基本的に:「Excelが大嫌いなのでRedmineを使っている」というのがスタンスです。 ですが、「大嫌いなExcelシートで加工した方が効率がいい状況」は多々発生します。

そんな加工したデータをチケットとして登録するためのプラグインを導入しました。

RedmineにはCSVインポート機能が備えられているものの、本項で紹介するプラグインはチケットの更新も行えるのが特徴です。

プラグイン名

動作を確認した環境

導入時

手順

さっくりとした手順

  1. SSHログイン後、Redmineプラグインに移動
  2. gitでレポジトリをダウンロード
  3. DBマイグレーション
  4. Webサービス再起動

Redmineプラグインディレクトリに移動します。

cd /home/www-data/redmine/plugins && pwd

自分の環境に合わせます。

プラグインを配置します。

sudo -u www-data git clone https://github.com/agileware-jp/redmine_importer
ls -ld redmine_importer

このディレクトリがあることを確認します

Redmineルートディレクトリに移動します。

cd /home/www-data/redmine

自分の環境に合わせます。

DBのマイグレーションを行います。

sudo -u www-data bundle exec rake redmine:plugins:migrate RAILS_ENV=production

Webサービスを再起動します。

sudo systemctl restart apache2

設定後の動作

  1. 管理者権限でRedmineにログインします。
  2. プロジェクト > 設定>モジュールに進み「importer」にチェックを入れます。
  3. プロジェクトのタブに「インポート」が表示されれば動作完了です。

こちらではインストールまで実施。具体的な使い方は別途紹介します。

Redmine5.1に全文検索プラグインをインストール

概要

Redmineの検索機能を強化するプラグインを導入し、検索効率を上げます。

プラグイン名

動作を確認した環境

前提

導入時

さっくりとした手順

  1. レポジトリ及び追加パッケージのインストール
  2. gitでレポジトリをダウンロード
  3. 新規ジェムをインストール
  4. DBマイグレーション
  5. Webサービス再起動
  6. Redmine管理画面での設定変更
  7. DB再マイグレーション(記事のインデックス化)
  8. 設定確認

レポジトリをインストールします。

sudo aptitude install-V software-properties-common lsb-release
sudo add-apt-repository "deb http://security.ubuntu.com/ubuntu $(lsb_release --short --codename)-security main restricted"
sudo add-apt-repository ppa:groonga/ppa

mroongaパッケージをインストールします。

sudo aptitude update
sudo aptitude install -V mysql-server-mroonga

MySQLの再起動を行います。

sudo systemctl restart mysql.service 
sudo systemctl status mysql.service 

全文検索プラグインインストール

cd /home/www-data/redmine/plugins && pwd

自分の環境に合わせます。

sudo -u www-data git clone  https://github.com/clear-code/redmine_full_text_search
ls -ld redmine_full_text_search

ディレクトリがあることを確認します。

cd /home/www-data/redmine && pwd

自分の環境に合わせます。

sudo -u www-data bundle install
sudo -u www-data bundle exec rake redmine:plugins:migrate RAILS_ENV=production
sudo systemctl restart apache2

Redmine管理画面での設定変更

  1. Redmineに管理者アカウントでログインします。
  2. 管理>プラグインからFull Text Search pluginの設定をクリックします。
  3. スコアを表示と類似チケットを表示にチェックを入れて保存します。

既存文書のインデックス化

プラグインのGithubで以下の通り書かれているので、

You need to create index for existing data. You need to run full_text_search:synchronize task until no more synchronize target data.

これに対応します。

再びサーバでのコマンド操作です。

cd /home/www-data/redmine && pwd

自分の環境に合わせます。

sudo -u www-data RAILS_ENV=production bin/rails full_text_search:synchronize

容量によっては時間がかかります。

インデックス後、ブラウザでRedmineにアクセスし、検索できることを確認します。

備考

上記インデックス作成は既存データに対して用いるものであり、本プラグイン導入後は自動的に同期してくれるようです。