【Redmine】Redmine Lightbox 2が動作しなかった時にやったこと

12月 1, 2019

どうも
今回はRedmineのプラグイン「Redmine Lightbox 2」を入れた際に起きたこと
対応したことを書きます。

Redmine Lightbox 2とは

チケットに添付した画像をポップアップ表示してくれるRedmineのプラグインです。
プラグインを入れてないと画像リンクをクリックした際に別ページに飛ばされますが、
ポップアップ表示するのでみるのがとても楽です。
入れ方としては以下のページを参考にしてみてください。

※こちらは別プラグインですが、入れ方は同じです。
※尚、コマンドラインでのインストール方法になります。

Redmine Lightbox2のダウンロード元はこちら
RedmineLightbox2

RedmineにRedmine Lightbox 2を入れたのに動かない！？

Redmineに、Redmine Lightbox2のプラグインを導入するという作業が発生しました。
ファイルをgithubから直接ダウンロードし、Redmineアプリのpluginsフォルダに入れ展開。
rakeコマンド→Redmineの再起動を行いました。
（/redmineのインストールフォルダ/plugins/）

該当のサムネイルをクリックすると・・・

通常時にクリックしたと同じ動作になり
ポップアップしませんでした。

rakeコマンドも実施したはずなのに・・・

調べたこと

・Redmineにそもそもプラグインが導入できているか？
・Redmine Lightbox2のバージョンの調査（Redmineのバージョンがプラグインに合わないとそもそも入らないようです）
・githubのインストール手順を再参照（「Plugin installation」の項目にインストール方法がありました）

プラグインが導入できているかを確認

Redmine管理画面（上部の管理リンクをクリック）からプラグインリンクをクリック

Redmine上で認識されていることを確認

バージョンの調査

Redmine上で認識されていることから、バージョンの線は薄いと判断し調査優先度を下げました

githubのインストール手順を再参照

Plugin installationには以下のように書かれていました

・Clone or download this repo into your redmine_root/plugins/ folder
　$ git clone https://github.com/paginagmbh/redmine_lightbox2.git
・If you downloaded a tarball / zip from master branch, make sure you rename the extracted 　folder to redmine_lightbox2
・You have to run the plugin rake task to provide the assets (from the Redmine root directory):
　$ rake redmine:plugins:migrate RAILS_ENV=production
Restart Redmine

引用元：RedmineLightbox2

直訳すると

・Redmineのインストールフォルダ/plugins/にgitから対象のリポジトリをクローンする（https://github.com/paginagmbh/redmine_lightbox2.git）
・クローンせずにzip圧縮されているフォルダをダウンロードし、pluginsフォルダに配置した場合は、解凍後フォルダ名を「redmine_lightbox2」にする
・rakeコマンド（rake redmine:plugins:migrate RAILS_ENV=production）を実行する
・Redmineを再起動する

怪しいところを確認

フォルダ名変更の作業をしていなかったことを思い出しフォルダ名を確認しました。

あ・・・
フォルダ名が、「指定されていたフォルダ名」じゃなかったです。

原因はフォルダ名を変更していなかった

フォルダ名を「redmine_lightbox2」（フォルダ名の変更してなかった）にしていなかった模様でした。
（インストール手順にフォルダ名を変えましょうという記述があったのにも関わらず）
まさかフォルダ名が固定の文字だとは思いませんでした。
（解凍した際にできたフォルダ名をそのまま利用してました・・・）

なので、ここは手順に乗っ取りフォルダ名を「redmine_lightbox2」に変更後、Redmineを再起動。
その後プラグインの動作を確認してみました。

うまくポップアップされました！
なんという凡ミス・・・

他のプラグインでも同じようなことが起こりうる

他のプラグインについても同じようにフォルダ名を変更する手順がありました。
プラグイン導入時には、ディレクトリに配置するフォルダ名に指定がないかちゃんと確認しましょう。

まとめ

「まさか」や「流石に」ということもミスの原因だったりします。
なのでミスをしてしまったら、その原因を探るためにも一つず手順を追っていくことが大事だなと思いました。

今回は以上！