概要
Redmineのプラグインを導入する際の基本的な手順をメモしておきます。
前提
こちらは筆者のメイン環境です。各自、自分の環境に合わせてください。
- 既にRedmineがインストールされている状態
- Ubuntu系OS
- WebサーバとしてApache2を利用
- Ruby on RailsでApacheと連携
- RedmineはApacheの実行ユーザ(www-data)
インストールの基本
- A.プラグインを
/redmine/root/directory/plugins
配下に設置(必須)
- B.依存関係があるrubyプログラムをインストール(オプション)
- C.DBマイグレーション(オプション)
- D.Webサービス再起動(必須)
- E:動作確認(必須)
A-1:Zipファイルをダウンロードする場合の手順
A-1.1:作業用ディレクトリに移動します。
cd /hoge
任意のディレクトリを指定します。
A-1.2:ZIPファイルを入手します。
- curl
- wget
- scpなどで転送
- デスクトップを兼ねている場合はダウンロード
など、任意の手を用います。
A-1.3:ファイルを解凍します。
unzip plugin.zip
A-1.4:解凍されたファイル群のディレクトリの所有者を変更します。
sudo chown -R www-data:www-data plugin-hoge
バージョン番号が付与されているパターンが多いです
A-1.5:Redmineのプラグインディレクトリに配置します。
sudo mv plugin-hoge /redmine/root/directory/plugins/plugin
配置する際に、バージョン名などを消しておきます。
→ ここを行ったらB以降に進みます。
A-2:git cloneする場合の手順
A-2.1:Redmineのプラグインディレクトリに移動します。
cd /redmine/root/directory/plugins && pwd
自分の環境に合わせます。 (例:/var/lib/redmine
)
筆者環境は/home/www-data/redmine
です
A-2.2:git cloneを行います。
sudo -u www-data git clone git_repository
大概はgithubのURLをそのまま(https://込み)です。
→ ここを行ったらB以降に進みます。
B: 依存関係があるrubyプログラムをインストールする場合の手順(オプション)
B-1: redmineのrootディレクトリに移動します。
cd /redmine/root/directory/ && pwd
自分の環境に合わせます。
B-2. Bundle installを行います。
sudo -u www-data bundle install
Bundle complete!
と出たらOKです。
→ ここを行ったらC以降に進みます。
B-1: redmineのrootディレクトリに移動します。
cd /redmine/root/directory/ && pwd
自分の環境に合わせます。
C: DBマイグレーションを行う場合の手順(オプション)
C-1: redmineのrootディレクトリに移動します。
cd /redmine/root/directory/ && pwd
自分の環境に合わせます。
C-2: DBのマイグレーションを行います。
sudo -u www-data bundle exec rake redmine:plugins:migrate RAILS_ENV=production
エラーが出てこなければOKです。
→ ここを行ったらD以降に進みます。
D:Webサービスの再起動
sudo systemctl restart apache2.service
systemctl status apache2.service
active (running)
を確認します。
E: 動作確認
- Redmineに管理者権限でログインします。
- 管理>プラグインに進みます。
- インストールしたプラグインがあることを確認します。
- 他の機能が動くことを確認します。