自宅のRedmineに新しいプラグインを導入したので手順の解説とレビューです。
今回導入したのは、Hide Sidebarというプラグイン。
機能はシンプルで、Redmineのサイドバーを隠してくれるというもの。
サイドバーは↓これ
チケット一覧で表示する項目が増えてくると地味に邪魔だったのでありがたい。
環境
OS
- CentOS 7.5（VMWare）
インストール済みソフトウェア
- Redmine 3.4.7 stable
- ruby 2.2.2
事前準備
Redmineのバージョンとプラグインのバージョンの互換性を確認
作業に入る前にRedmineのバージョンとプラグインのバージョンの互換性を確認しておきます。
互換性は大抵プラグインのページに記載されています。
プラグインの最新バージョン（執筆時）は、0.0.8のようで、Redmine 3.3.x系と互換性有りとの事。
つまり、私の環境のRedmine 3.4.7は互換性が確認されていないようです。
ただ、同ページのユーザーレビューを見ると、Redmine 4.0.0 stable でも動いたよ！という報告があったので、私のバージョンでも大丈夫でしょう。
導入手順
pluginsディレクトリに移動
cd /[REDMINE_HOME]/plugins/
本体をコピー
wget https://gitlab.com/bdemirkir/sidebar_hide/-/archive/0.0.8/sidebar_hide-0.0.8.zip
プラグインのリポジトリにも手順が導入手順が記載されていますが、通常はgit clone コマンドによるコピーで問題ないです。
私はGitHubアカウントを保持していない為、wgetコマンドでコピーしました。
zipを解凍
unzip sidebar_hide-0.0.8.zip
ディレクトリ名をプラグイン側で指定された名前と一致させる
mv sidebar_hide-0.0.8 sidebar_hide
Redmineのプラグインディレクトリ名はプラグイン側で指定した名前と一致していないとエラーになるので要注意です。
今回は、sidebar_hideと指定されているようでしたので、その名称に変更しています。
解凍済みzipを削除
rm -rf sidebar_hide-0.0.8.zip
再起動
reboot
サイドバーを隠すというシンプルな機能なだけあって、DBのマイグレーションは不要ですね。
動作確認、感想
再起動後、チケット一覧画面を確認すると、サイドバーにボタンが表示されていました。
実際の動きはこんな感じです。
ちなみにサイドバーを閉じた状態でブラウザを終了すれば、次回表示時も閉じた状態で表示してくれます。
内部的には・・・なるほど、Cookieに表示状態を保存して、次回表示時に読み込んでいるようです。
おわりに
シンプルな機能ながら、割と重宝するプラグインかもしれない。
表示状態を記憶してくれるのはありがたいですね。
