r-labs

h1. プラグインのインストール方法

{{>toc}}

プラグインのインストールは以下の手順で行います。

# プラグインを以下の場所におきます。

  (Redmine インストールディレクトリ)/plugins

  (Redmine インストールディレクトリ)/vender/plugins   [Redmine 1.4 以前] 

# 以下のコマンドを実行し、プラグイン用のデータベースを作成します。(必要時)

  $ rake redmine:plugins:migrate RAILS_ENV=production

  $ rake db:migrate_plugins RAILS_ENV=production   [Redmine 1.4 以前]

# Redmine (Web サーバ) を再起動します。

# 管理の[プラグイン]メニューからプラグインがインストールされていることを確認し、

  プラグインの設定を行います。(必要時)

# [ロールと権限] で権限を設定します。(必要時)

# プロジェクトの設定でインストールしたプラグインのモジュールを有効にします。(必要時)

簡単なものであれば、plugins にプラグインをおいて、 Redmine を再起動するだけでインストールできます。

以下は各項目の詳しい説明と注意点です。

h2. プラグインの展開

ほとんどの場合、プラグインは圧縮ファイルの形式で公開されていると思います。これをダウンロードして plugins に展開します。

展開する時には以下ような構成になるようにします。

<pre>

<redmine_dir>/plugins/<plugin_name>/

                                    init.rb

                                    app/

                                       :

</pre>

プラグインによってはディレクトリの名前がプラグイン名になっていない場合があります。大抵はそのままでも問題ないのですが、たまに [[TipsOriginalImage|エラーになる場合]] があります。

その場合、 init.rb にある以下の行でプラグイン名を調べて、ディレクトリ名を変更する必要があります。

<pre><code class="ruby">

Redmine::Plugin.register :プラグイン名 do

</code></pre>

プラグインが GitHub などで公開されている場合は <redmine_dir>/plugins ディレクトリで以下のコマンドを実行して、そこに直接ダウンロードすることも出来ます。

<pre>

git clone git://github.com/user_name/name_of_the_plugin.git.

</pre>

git clone の後のアドレスはプラグインの GitHub のページからクリップボードにコピーしたものを使用します。

プラグインが Bitbucket などで公開されている場合は <redmine_dir>/plugins ディレクトリで以下のコマンドを実行して、そこに直接ダウンロードすることも出来ます。

<pre>

hg clone https://bitbucket.org/user_name/name_of_the_plugin

</pre>

hg clone の後のアドレスはプラグインの Bitbucket のページからクリップボードにコピーしたものを使用します。

h2. プラグイン用データベースの作成

インストールするプラグインがデータベースを使用する場合には、プラグインのインストールディレクトリに移動して、以下のコマンドで Migratation という処理を実行する必要があります。 

<pre>

  $ rake redmine:plugins:migrate RAILS_ENV=production

</pre>

プラグインで Migratatin が必要かどうかわからない場合には余分にやっても特に問題はないのでとりあえずやっておきましょう。

データベースを操作するので、コマンドを実行する前にデータベースのバックアップはとっておいた方が良いです。

h2. Redmine の再起動

プラグインをインストールした場合、 Redmine の再起動が必要になります。

これは Apache などの Web サーバの再起動にあたります。 各 Web サーバの方法で再起動して下さい。

h2. プラグインの設定

以下の手順でプラグインの情報ページを開きます。

 トップメニューの _[管理]_  →  _[プラグイン]_ 

インストールに成功しているとリストに追加されます。

プラグインに設定機能が付いている場合には [設定] のリンクがリスト項目に表示されていますので、そこをクリックすると各プラグインの設定ページとなります。

!plugin_settings.png!

設定ページにはプラグインのデフォルトの設定が入っています。

新しく追加したプラグインでは問題ないのですが、アップグレードしたプラグインなどで新しく追加された設定項目はデフォルトの設定にならないので、確認しておいた方がいいと思います。

h2. プラグインの権限の設定

プラグインがプロジェクトごとに使用するタイプの場合には、[ロールと権限] のページで各操作ごとの権限を設定する必要があります。

以下の手順でページを開いて、チェックを入れます。

 トップメニューの _[管理]_  →  _[ロールと権限]_  →  _[権限レポート]_

!permission_ja.png!

デフォルトではチェックが一つも入っていません。

そのため、この権限の設定を忘れるとインストールした人は管理者権限があるので使えるけど他の人はまったく使えないという状況になってしまいますので、注意してください。

h2. プロジェクトの設定でモジュールを有効にする

プラグインがプロジェクトごとに使用するタイプの場合には、各プロジェクトの設定ページでインストールしたプラグインのモジュールを有効にする必要があります。

!module_add.png!

新しく作成するプロジェクト時にデフォルトでチェックを入れたい場合には管理の設定ページで設定します。

 トップメニューの _[管理]_  →  _[設定]_  →  _[プロジェクト]_ のタブ

!default_plugin.png!

すでに作成済みのプロジェクトに対して一括してモジュールを有効にする方法はありません。(多分)