プロジェクト

全般

プロフィール

Wiki » ソフトウェア開発環境 » Redmine »

Redmineにプラグインを入れる

チケット関連プラグイン

Issute Templateプラグイン

リポジトリがbitbucketからgithubに移動しています（2017-06）。

Plugins Directory >> Issue Template

プロジェクト毎にテンプレートを定義することと、グローバルにテンプレートを定義することが可能です。
テンプレートは、新規チケットでトラッカーを選択すると自動で挿入することと、利用者がテンプレートを選択操作したときに挿入することが可能です。

インストール（Redmine 2.x）

plugins$ hg clone https://bitbucket.org/akiko_pusu/redmine_issue_templates
  :
plugins$ cd ..
redmine$ bundle update
  :
redmine$ bundle exec rake redmine:plugins:migrate RAILS_ENV=production
  :

リポジトリからクローンします。追加のgemを必要とするので、bundle updateでgemを更新してからプラグインのmigrateを実行します。

インストール（Redmine 3.0,3.1）

2015-03-01現在、Redmine 3.0.0対応版が正式リリースとなりました。

plugins$ git clone https://github.com/akiko-pusu/redmine_issue_templates
  :
plugins$ cd ..
redmine$ bundle update
  :
redmine$ bundle exec rake redmine:plugins:migrate RAILS_ENV=production
  :
bundle updateを実行しないとエラー（shoulda がない）

リポジトリから展開後、rake redmine:plugins:migrateを実行すると次のようにエラーが発生しました。

redmine$ bundle exec rake redmine:plugins:migrate RAILS_ENV=production
Your Gemfile lists the gem simplecov-rcov (>= 0) more than once.
You should probably keep only one of them.
While it's not a problem now, it could cause errors if you change the version of just one of them later.
Could not find gem 'shoulda (>= 0) ruby' in the gems available on this machine.
Run `bundle install` to install missing gems.
redmine$

前半のメッセージはsimplecov-rcovが複数定義されているので注意してねという警告のようです。
→ Banner、Issue Templateで定義あり
後半は、shoulda がインストールされていないとのエラーです。
どちらもtestグループとして定義されているのですが、1回bundle updateしてあげないとだめでした。

使用方法

[管理] > [ロールと権限] で、必要なロールに必要な権限を付与します。
使用するプロジェクトの[設定]>[モジュール]でチケットテンプレートにチェックを付けます。
使用するプロジェクトの[設定]>[チケットテンプレート]でテンプレートの作成、一覧、管理が行えます。

Code Reviewプラグイン

Plugins Directory » Code Review

インストール（Redmine 2.x／3.0,3.1）

plugins$ hg clone https://bitbucket.org/haru_iida/redmine_code_review
  :
plugins$ cd ..
redmine$ bundle exec rake redmine:plugins:migrate RAILS_ENV=production
  :

Parking Lot Chartプラグイン

Plugins Directory » Parking Lot Chart Plugin

インストール

plugins$ git clone https://github.com/daipresents/redmine_parking_lot_chart.git
  :

トラブルシュート

Redmine 3.0.0ではエラー
  • routesでmatch定義にviaオプション指定がないためエラー
  • find_all_by_is_closed がNoMethodError

XLS Exportプラグイン

Plugins Directory » XLS Export
オリジナルのプラグインサイトは保守が滞っています。次のGithubでtwo-pack氏によるアクティブな保守が行われています。
https://github.com/two-pack/redmine_xls_export

インストール（Redmine 2.x／3.0,3.1）

plugins$ git clone https://github.com/two-pack/redmine_xls_export.git
  :
plugins$ cd ..
redmine$ bundle update
  :

XLSX format issue exporterプラグイン

Plugins Directory » Redmine XLSX format issue exporter
上述XLS Exportプラグインをアクティブにメンテナンスしているtwo-pack氏のオリジナルプラグイン。履歴や添付ファイルの出力機能はなくシンプルな構成のプラグイン。

インストール（Redmine 2.x/3.0）

plugins$ git clone plugins$ git clone https://github.com/two-pack/redmine_xlsx_format_issue_exporter.git
  :
plugins$ cd ..
redmine$ bundle update
  :

Easy Ganttプラグイン

Plugins Directory » Easy Gantt
有償のPro版と機能を限定した無償のFree版があります。日／週／月単位の表示切替、マイルストーン／タスクの期間変更、
Pro版ではベースライン機能、クリティカルパス機能、ガントチャート画面上で新規マイルストーン／タスクの作成、プロジェクトをまたいだガントチャート表示などが可能です。

入手（Free版）

Easy RedmineサイトのGanttプラグインページ
上述ページにアクセスし、[Get Gantt Plugin for free]をクリックし、氏名、メールアドレス、電話番号を入力し[Submit]をクリックします。
メールアドレスにメールが届くので、そこからEasyGanttFree.zipをダウンロードします。

インストール

ダウンロードしたEasyGanttFree.zipを、Redmineのプラグイン格納ディレクトリ下に展開します。

plugins$ unzip ~/EasyGanttFree.zip
  :
plugins$ ls easy_gantt
Gemfile  README.rdoc    app     config   lib   version
LICENSE  after_init.rb  assets  init.rb  spec
plugins$ cd ..
redmine$ bundle update
  :
redmine$ bundle exec rake db:migrate RAILS_ENV=production
  :
redmine$ bundle exec rake redmine:plugins:migrate RAILS_ENV=production
  :

Redmineを再起動します。

設定

Redmineの[管理] > [ロールと権限] で、Easy Redmineの権限にチェックを付けます。

easyredmine_role-1.png

さらなる詳細は

Wiki関連プラグイン

Wiki Extensionsプラグイン

Plugins Directory » Wiki Extensions

主要機能（よく使っているもの）

  • Wikiページへのコメント記入機能
  • Wikiページへのタグ付け・タグクラウド機能
  • プロジェクト毎のスタイルシート定義機能
  • フッター定義機能
  • 最近更新されたページ、更新者、更新時間をWikiページに埋め込み
  • プロジェクトメニュータブに任意のWikiページへのリンク追加
  • Wikiページ内に外部のWebページを表示
  • Wikiページのアクセスカウンタ
  • オートプレビュー（Wiki機能の編集中に指定時間ごとにプレビューを更新）
  • テーブルのヘッダーでソート
  • 投票機能

インストール（Redmine 3.4.x）

プラグインをgit cloneでプラグインディレクトリに展開します。

plugins$ git clone https://github.com/haru/redmine_wiki_extensions
Cloning into 'redmine_wiki_extensions'...
remote: Counting objects: 2203, done.
remote: Total 2203 (delta 0), reused 0 (delta 0), pack-reused 2203
Receiving objects: 100% (2203/2203), 592.76 KiB | 1.27 MiB/s, done.
Resolving deltas: 100% (1475/1475), done.
plugins$

DBのマイグレートを実行します。

$ bundle exec rake redmine:plugins:migrate RAILS_ENV=production

インストール（Redmine 2.x/3.0,3.1）

プラグインをhg cloneでプラグインディレクトリに展開します。

plugins$ hg clone https://bitbucket.org/haru_iida/redmine_wiki_extensions
destination directory: redmine_wiki_extensions
requesting all changes
adding changesets
adding manifests
adding file changes
added 317 changesets with 816 changes to 151 files (+3 heads)
updating to branch default
126 files updated, 0 files merged, 0 files removed, 0 files unresolved
plugins$

DBのマイグレートを実行します。

$ bundle exec rake redmine:plugins:migrate RAILS_ENV=production

Clipboard Image Pasteプラグイン

Plugins Directory » Attach image from clipboard

画面キャプチャ等クリップボードにコピーされた画像を直接Redmineに添付ファイルとして貼ることができます。
クリップボードからペーストした画像の一部（矩形）を切り出して貼ることができます。

インストール（Redmine 2.x／3.0,3.1）

プラグインをgit cloneでプラグインディレクトリに展開します。

plugin$ git clone https://github.com/peclik/clipboard_image_paste.git

Redmineを再起動します。

インストール（Redmine 4.x）

本家のClipboard Image PasteはRedmine 4.xには未対応ですが、次のフォーク版が対応しているようです。
https://github.com/Utopism/clipboard_image_paste

Embedded Flash Macroプラグイン

Redmine Plugins Directory >> Embedded Flash Macro

インストール（Redmine 2.x/3.0）

プラグインをgit cloneでプラグインディレクトリに展開します。

~$ cd /var/lib/redmine/plugins
plugins$ git clone https://github.com/fcrespel/redmine_embedded_flash.git

Redmineを再起動します。

~$ sudo service unicorn restart

使用方法

  • デフォルトのサイズでflash動画をインライン表示
    {{flash(<ファイル名>|<URL>)}}
  • サイズを指定してflash動画をインライン表示
    {{flash(<ファイル名>|<URL>,幅,高さ)}}

Wiki Lists プラグイン

Redmine Plugins Directory >> Wiki Lists

インストール

プラグインをgit cloneでプラグインディレクトリに展開します。

~$ cd /var/lib/redmine/plugins
plugins$ git clone https://github.com/tkusukawa/redmine_wiki_lists.git

Redmineを再起動します。

~$ sudo service unicorn restart

使用方法

条件にマッチしたチケットの一覧表示もしくは件数の集計を表示します。
条件は、あらかじめ設定されたカスタムクエリか、属性の演算を指定します。

{{ref_issues(条件..., 表示列...)}}

カスタムクエリはIDまたは名前を指定可能です。
属性は、プロジェクトID、トラッカーID、題名、説明、期日、カテゴリID、ステータスID、割当者ID、優先度ID、修正したバージョンID、作成者IDなどなど。
演算は、一致、不一致、以上、以下、などなど

以下のブログにref_issuesを用いた件数集計の使い方を書きました。
Redmine Wiki Lists プラグインの使い方メモ

LaTeX MathJax マクロ

https://github.com/process91/redmine_latex_mathjax

JavaScriptライブラリ MathJax を用いて数式をWikiに表示するマクロを提供するプラグインです。

インストール

プラグインをgit cloneでプラグインディレクトリに展開します。

~$ cd /var/lib/redmine/plugins
plugins$ git clone https://github.com/process91/redmine_latex_mathjax.git

依存gemを取り込みます。

plugins$ cd ..
redmine$ bundle install
:
Installing render_parent 0.0.8

Redmineを再起動します。

設定

本プラグインは、MathJaxライブラリをURL指定で参照します。init.rbに参照先URLを記載します。デフォルトでは次のURLが記述されています。

  settings :default => {
    'latex_mathjax_url' => 'https://cdn.mathjax.org/mathjax/latest/MathJax.js',

インターネットアクセスが出来ない環境では、URL参照できる場所にMathJax.jsを配置し、そのURLをinit.rbに記載します。

使用方法

Wikiにマクロを記述します。

{{mj(\sum_i x_i)}} $ \sum_i x_i $
{{mj( y(\boldsymbol{x}) = f(\boldsymbol{w}^T \boldsymbol{x}) )}} $ y(\boldsymbol{x}) = f(\boldsymbol{w}^T \boldsymbol{x}) $
{{mj(x = \frac{-b \pm \sqrt{b^2 - 4ac}}{2a})}} $ x = \frac{-b \pm \sqrt{b^2 - 4ac}}{2a} $

数式の記法については

リポジトリ関連プラグイン

Github hookプラグイン

Redmine Plugins Directory >> Github Hook

インストール

インストール方法は、gemパッケージとプラグインと2つ提供されています。ここではプラグインとしてインストールします。

プラグインをgit cloneでプラグインディレクトリに展開します。

~$ cd /var/lib/redmine/plugins
plugins$ sudo git clone git://github.com/koppen/redmine_github_hook.git
plugins$ sudo chown -R redmine.redmine redmine_github_hook/

Redmineを再起動します。

~$ sudo service unicorn restart

使用方法

Redmineのリポジトリ機能はGitの場合、同じマシン上（ローカル）のディレクトリにあるbareリポジトリを参照することしかできません。そこで、まずローカルにGithubのリポジトリのミラーを作成します。

ミラーを作る場合、sshの鍵認証を使います。redmine実行ユーザーでGithubアクセス用のssh鍵ファイルを作成します。メールアドレスをGithubアカウントに登録したものに設定しておきます。

~$ ssh-keygen -t rsa -C "torutk@example.com" 
Generating public/private rsa key pair.
Enter file in which to save the key (/home/redmine/.ssh/id_rsa): 
Enter passphrase (empty for no passphrase):
Enter same passphrase again:

生成された公開鍵（id_rsa.pub）をcatし表示された文字列をコピーし、GithubのSSH鍵管理に追加します。

疎通確認をします。

~$ ssh -T git@github.com
Warning: Permanently added the RSA host key for IP address '192.30.252.129' to the list of known hosts.
Hi torutk! You've successfully authenticated, but GitHub does not provide shell access.

注）疎通確認のユーザー名はgitにします。個人のアカウントにするとエラー（Permission denied (publickey).）になります。

GithubのリポジトリのミラーをRedmineマシン上に作成します。

~$ sudo mkdir /var/lib/git_mirror
~$ sudo chown redmine.redmine /var/lib/git_mirror
~$ cd /var/lib/git_mirror
git_mirror$ git clone --mirror git://github.com/torutk/jarmanifestviewer.git
Cloning into bare repository 'jarmanifestviewer.git'...
  :

Redmine上で、このディレクトリをリポジトリに設定します。

次に、Githubの対象プロジェクトを開き、右側メニューの"Settings"をクリックします。
左側メニューの"Webhooks & Services"をクリックします。
[Add webhook]ボタンをクリックします。
Payload URLにフックURLを入力します。Github HookプラグインはGithubのリポジトリ名とRedmineのプロジェクト識別子が同じことをデフォルトとしています。その場合は、<redmine_url>/github_hook となります。
違う場合は、project_id=<Redmineプロジェクト識別子>を付加します。
指定したRedmineプロジェクトに複数のリポジトリがあると、Github Hookがすべてをチェックするので、repository_id=<Redmineリポジトリ識別子>を付加します。

http://www.torutk.com/github_hook?project_id=swd&repository_id=github_jarmanifestviewer

Content typeはデフォルトのまま（application/json）としています。
イベントの種類はデフォルトのまま（Just the push event）としています。

表示・レイアウト関連

sidebar hideプラグイン

Plugins Directory » Hide Sidebar

インストール（Redmine 2.x/3.0,3.1）

~$ cd /var/lib/redmine/plugins
plugins$ git clone https://github.com/bdemirkir/sidebar_hide.git

使用方法

Redmine画面の次の箇所をクリックすると、右側サイドメニューが隠れます。

showing_sidebar.png

Redmine画面の次の箇所をクリックすると、右側サイドメニューが現れます。

hiding_sidebar.png

Bannerプラグイン

Plugins Directory » Banner

インストール（Redmine 2.x/3.0,3.1）

~$ cd /var/lib/redmine/plugins/
plugins$ git clone https://github.com/akiko-pusu/redmine_banner.git
  :
plugins$ bundle exec rake redmine:plugins:migrate RAILS_ENV=production
  :

Startpageプラグイン

Plugins Directory » Redmine Start Page

Maintenance Modeプラグイン

Plugins Directory » Maintenance Mode Plugin

インストール

plugin$ git clone https://github.com/tofi86/redmine_maintenance_mode.git

備考

よく考えたらRedmineが立ち上がっているときでないと表示されないので、Redmineを停止する保守には使えないですね。

Theme Changerプラグイン

Plugins Directory >> Theme Changer

ユーザー毎にRedmineのテーマを選択可能にするプラグインです。

インストール

~$ cd /var/lib/redmine/plugins/
plugins$ git clone https://github.com/haru/redmine_theme_changer.git
  :
plugins$ bundle exec rails redmine:plugins:migrate RAILS_ENV=production
  :

設定

ログイン後、右上の[個人設定]から、[情報]領域の中に[テーマ]欄が増えています。ここに、システムに用意されているテーマの一覧が選択可能です。

機能追加プラグイン

用語集プラグイン

Plugins Directory » Glossary

2014-12-14時点で上記公式サイトから入手できる最新版0.6.1は、Redmine 2.5.2, 2.6.0で正常に動作しません。次のURLにRedmine 2.3.xに対応するフォーク版が公開されているのでこちらを使うとよいかと思います。

https://github.com/chiastolite/redmine_glossary

インストール（公式サイト版）

ダウンロードページ から最新版をダウンロードします。
  • rp-glossary-0.6.1.zip

~$ cd /var/lib/redmine/plugins
plugins$ unzip /tmp/rp-glossary-0.6.1.zip
plugins$ bundle exec rake redmine:plugins:migrate RAILS_ENV=production
plugins$

インストール（chiastoliteフォーク版）

次のリポジトリのクローンを設けます。
https://github.com/chiastolite/redmine_glossary

~$ cd /var/lib/redmine/plugins
plugins$ git clone https://github.com/chiastolite/redmine_glossary.git
plugins$ bundle exec rake redmine:plugins:migrate RAILS_ENV=production
  :
plugins$

インストール（maxrosselloフォーク版）

次のリポジトリのクローンを設けます。
https://github.com/maxrossello/redmine_glossary.git

plugins$ git clone https://github.com/maxrossello/redmine_glossary.git
  :
plugins$

使用方法

  • [管理] > [ロールと権限] で、用語集の権限にチェックを付けます。
  • [管理] > [プラグイン] > Redmine Glossary Pluginの[設定]で、非表示項目を指定できます。

アンインストール

$ bundle exec rake redmine:plugins:migrate NAME=redmine_glossary VERSION=0 RAILS_ENV=production

公式リポジトリ最新版の試行

Subversionリポジトリの最新版を試してみました（2014-11-22時点でr82）。

~$ cd /var/lib/redmine/plugins
plugins$ svn checkout http://svn.sourceforge.jp/svnroot/rp-glossary/trunk/redmine_glossary
plugins$ bundle exec rake redmine:plugins:migrate RAILS_ENV=production
  :

  • カテゴリの新規作成をすると404エラー
  • あたらしい用語を作成するとPage not foundエラー

Agileプラグイン（RedmineCRM）

商用のAgile開発用プラグインだがLight版（機能限定:Agile boards, Version planner, Burndown chartの3機能）が無償で利用可能です。
ダウンロードにはアカウント（無償登録）が必要でした。

http://www.redminecrm.com/projects/agile/pages/1

ダウンロードとインストール

Light版の[Download]をクリックすると、アカウント作成画面が出ます。そこでメールアドレスとパスワードを入力すると折り返しメールが来ます。メールに記載のURLをクリックするとアカウントが活性化します。そのアカウントでサインインしてダウンロードします。

  • redmine_agile-1_3_9-light.zip

Redmineのpluginディレクトリにこれを展開し、migrateします。

  • agile_colorsテーブルの作成
  • agile_ranksテーブルの作成

使ってみる

プロジェクトの[設定] > [モジュール]で、Agileを有効にします。プロジェクトに[Agile]タブが追加されます。

Agile boards機能は、基本的にチケット一覧をステータスごとに縦割りに表示する機能なようです。フィルターで特定バージョンに絞り込まないと、すべてのチケットがかんばんに出てしまいます。ストーリーとタスクという関係も特になさそうです。

Version planner機能は、チケットをバージョンごとに縦に並べて相互の行き来をドラッグ＆ドロップで実現したものです。ただ、バージョンが2つしか表示されないのはいまいちかも・・・。

カスタマイズ

View Customizeプラグイン

指定したURLのパターンにマッチしたページにJavaScriptおよびCSSの追加コードを差し込んでカスタマイズするプラグインです。
汎用性が高いです。

Plugins Directory » View Customize

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

インストール

redmine$ cd plugins
plugins$ git clone https://github.com/onozaty/redmine-view-customize.git
Cloning into 'redmine-view-customize'...
remote: Counting objects: 273, done.
remote: Total 273 (delta 0), reused 0 (delta 0), pack-reused 273
Receiving objects: 100% (273/273), 138.79 KiB | 0 bytes/s, done.
Resolving deltas: 100% (101/101), done.

plugins$ mv redmine-view-customize view_customize

plugins$ cd ..
redmine$ bundle exec rake redmine:plugins:migrate RAILS_ENV=production
  :

参考資料

画面をJavaScript/CSSで簡単にカスタマイズできるRedmineプラグインを作成しました
View Customize スクリプトリスト
View Customize Pluginで出来ること （第9回redmine.tokyo勉強会 2015-11-28）
View customize pluginを使いこなす （第10回redmine.tokyo勉強会 2016-05-14）
Redmine: チケット作成時に処理を行う
Redmine: チェックボックスのカスタムフィールドを2列で表示する
ある工場のRedmine画面カスタム【View customize plugin 活用例】
Redmineのプラグイン「view customize plugin」のカスタマイズ例

ほぼ4年前に更新