メインコンテンツへスキップ

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

概要

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

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

プラグイン名

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

動作を確認した環境

Redmine 4.2

導入時

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

手順

さっくりとした手順

  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. このように、プロジェクトにナレッジベースのタブが表示されていれば設定完了です。

上に戻る