Redmineプラグイン

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

AdditionalプラグインをRedmine4.2にインストール
Additional TagsプラグインをRedmine 4.2にインストール
Redmineプラグイン『Kanban』のインストール
Redmica_UI_Extensionのインストール
Redmine4.2にKnowledgebaseプラグインをインストール（及びプログラム修正）
Redmine 5.xにknowlegebaseをインストール。
Redmine 4.2にIssue_Badge_Pluginをインストール
Redmine 5.xにIssue_Badge_Pluginをインストール
Redmine4.2(5.x)にIssue_Template_Pluginをインストール
Redmine4.2に markdown Task Listプラグインのインストール。
Redmine shortcustのインストール（キーボードショートカットで操作できるプラグイン）
Redmine View Customizeのインストール。
Redmine4.2にRedmine_Issue_Importerをインストール
Redmine5.1に全文検索プラグインをインストール

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

概要

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

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

プラグイン名

Additionals

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

前提

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

動作を確認した環境

Redmine 4.2

導入時

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

手順

さっくりとした手順

SSHログイン後、作業ディレクトリに移動
wgetでRedmine4.2に即したパッケージをダウンロード
パッケージの配置
新規ジェムをインストール
DBマイグレーション
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

動作

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

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

概要

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

プラグイン名

additonal_tags
- https://github.com/AlphaNodes/additional_tags

動作を確認した環境

Redmine 4.2

前提：

稼働要件にadditonalsプラグインが必要です。(インストール方法)
additonalプラグインと同様に、2023年1月現在のバージョンはRedmine5.xから対応しているため、作業に少し手間が加わります。
既にredmine_tags (https://github.com/ixti/redmine_tags/) を導入している場合は、以下に示す手順によって設定済みのタグをインポートできます。

導入時

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

手順

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

さっくりとした手順

SSHログイン後、作業ディレクトリに移動
wgetでRedmine4.2に即したパッケージをダウンロード
パッケージの配置
旧プラグインのディレクトリ削除
新規ジェムをインストール
DBマイグレーション
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ディレクトリを削除します。

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

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

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

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

削除前のディレクトリ確認

ls -ld additional_tags redmine_tags

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

インストール済みのRedmine_Tagsディレクトリ削除

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

インストール後の動作

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

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

概要

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

これによって、

どのチケットが
どのステータスにあり
誰に割り当てられているか

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

プラグイン名

kanban
- https://github.com/happy-se-life/kanban

動作を確認した環境

Redmine 4.2
Redmine 5.1

導入時

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

手順

さっくりとした手順

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

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

cd /home/www-data/redmine/plugins

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

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

git cloneでの取得

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

取得確認

ls -ld kanban

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

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

sudo systemctl restart apache2

インストール後の設定

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

Redmica_UI_Extensionのインストール

概要

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

プラグイン名

Redmica_UI_Extension
- https://github.com/redmica/redmica_ui_extension

動作を確認した環境

Redmine 4.2
Redmine 5.1

導入時

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

手順

さっくりとした手順

SSHログイン後、Redmineプラグインに移動
gitでレポジトリをダウンロード
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

動作

mermaidマクロが使えること
セレクトボックスでキーワード検索が使えること
バージョン詳細画面にバーンダウンチャートが表示されること

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

詳細は

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

を参照してください。

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

概要

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

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

プラグイン名

Knowledgebase
- [https://github.com/alexbevi/redmine_knowledgebase]

動作を確認した環境

Redmine 4.2

導入時

Gem追加：要
DBマイグレーション：要
設定ファイル修正：要

手順

さっくりとした手順

SSHログイン後、Redmineプラグインに移動
gitでレポジトリをダウンロード
新規ジェムをインストール
設定ファイル修正
DBマイグレーション
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

動作後の確認

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

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

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

https://github.com/yzzy/redmine_knowledgebase

環境

Ubuntu 22.04
Apache 2.4
MySQL 8.0.3
Redmine 5.1

導入時

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

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

さっくりとした手順

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

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

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

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

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

git clone

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

clone確認

ls -ld redmine_knowledgebase/

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

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

Redmineのルートディレクトリに移動

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

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

bundle install

sudo -u www-data bundle install

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

Redmineのルートディレクトリに移動

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

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

マイグレーション

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

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

sudo systemctl restart apache2

動作後の確認

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

Redmine 4.2にIssue_Badge_Pluginをインストール

概要

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

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

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

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

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

プラグイン名

Redmine Issue Badge

動作を確認した環境

Redmine 4.2

導入時

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

手順

さっくりとした手順

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

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

cd /hoge && pwd

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

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

git clone

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

動作

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

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

概要

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

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

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

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

プラグイン名

Redmine Issue Badge

動作を確認した環境

Redmine 5.1

導入時

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

手順

さっくりとした手順

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

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

cd /home/www-data/redmine/plugins

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

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

git clone

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

動作

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

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

概要

チケットを発行するときの定型文を入れたい
プロジェクトによっては既に内容が決まっているとなおよい

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

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

プラグイン名

redmine_issue_templates
- Redmine 4.2
  - https://github.com/akiko-pusu/redmine_issue_templates
- Redmine 5.x
  - https://github.com/agileware-jp/redmine_issue_templates

動作を確認した環境

Redmine 4.2
Redmine 5.1

導入時

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

手順

さっくりとした手順

SSHログイン後、Redmineプラグインに移動
gitでレポジトリをダウンロード
新規ジェムをインストール
DBマイグレーション
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

動作

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

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

概要

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

- [ ] チェックリスト

という表記すると、

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

- [x] チェックリスト

と記入します。

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

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

プラグイン名

Redmine Markdown Task List Plugin

https://github.com/eichisanden/redmine_markdown_task_list

動作を確認した環境

Redmine 4.2

導入時

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

手順

さっくりとした手順

SSHログイン後、Redmineプラグインに移動
gitでレポジトリをダウンロード
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で強調表示にするなど、エディタ感覚でチケット管理を行えるプラグインをインストールします。

プラグイン名

Redmine shortcuts
- https://github.com/davidegiacometti/redmine_shortcuts

動作を確認した環境

Redmine 4.2
Redmine 5.1

導入時

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

さっくりとした手順

SSHログイン後、Redmineプラグインに移動
gitでレポジトリをダウンロード
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

動作

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

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

Redmine View Customizeのインストール。

概要

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

Redmine上の

ちょっとした挙動の修正
見た目の変更
メニューの追加

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

プラグイン名

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

動作を確認した環境

Redmine 4.2
Redmine 5.1
MySQL （なぜかMariaDBではうまくいきませんでした)

導入時

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

手順

さっくりとした手順

SSHログイン後、Redmineプラグインに移動
gitでレポジトリを「リネームして」ダウンロード
新規ジェムをインストール
DBマイグレーション
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

動作

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

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

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

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

概要

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

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

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

プラグイン名

redmine_importer
- https://github.com/agileware-jp/redmine_importer

動作を確認した環境

Ubuntu 20.04
Redmine 4.2
Apache 2.4

導入時

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

手順

さっくりとした手順

SSHログイン後、Redmineプラグインに移動
gitでレポジトリをダウンロード
DBマイグレーション
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

設定後の動作

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

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

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

概要

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

プラグイン名

redmine_full_text_search
- https://github.com/clear-code/redmine_full_text_search

動作を確認した環境

Redmine 5.1
mysql 8.0.3系
Ubuntu 22.04

前提

筆者が用いているRedmineのDBはMySQLを用いているので、その環境での手順です。

導入時

パッケージ追加: 要
Gem追加：要
DBマイグレーション：要
設定後のDBマイグレーション: 要

さっくりとした手順

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

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

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の再起動を行います。

MySQL再起動

sudo systemctl restart mysql.service

MySQL再起動確認

sudo systemctl status mysql.service

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

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

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

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

Redmineのルートディレクトリに移動

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

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

Bundle

sudo -u www-data bundle install

DBのマイグレーション

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

Apache再起動

sudo systemctl restart apache2

Redmine管理画面での設定変更

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

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

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

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

これに対応します。

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

Redmineのルートディレクトリに移動

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

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

インデックス化

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

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

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

備考

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