Redmine5.1に全文検索プラグインをインストール
概要
Redmineの検索機能を強化するプラグインを導入し、検索効率を上げます。
プラグイン名
- 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にアクセスし、検索できることを確認します。
備考
上記インデックス作成は既存データに対して用いるものであり、本プラグイン導入後は自動的に同期してくれるようです。