JaRedmineInstall » History » Version 1

Version 1/2 - Next » - Current version
Go MAEDA, 2011-04-21 17:30
copied from http://redmine.jp/guide/


Redmineのインストール

必要な環境

OS

RedmineはたいていのUNIX, Linux, Mac, Windowsシステム等、Rubyが利用可能なシステムで実行できます。

RubyおよびRuby on rails

Redmineの各バージョンで必要となるRailsのバージョンは以下の通りです。

Redmineのバージョン Ruby Rails Rack
trunk ruby 1.8.6, 1.8.7 Rails 2.2.2 Rack 1.0.1
trunk(r2493〜r2886) ruby 1.8.6, 1.8.7 Rails 2.2.2
trunk(〜r2492) ruby 1.8.6, 1.8.7 Rails 2.1.2
1.0.x ruby 1.8.6, 1.8.7 Rails 2.3.5 Rack 1.0.1
0.9.x ruby 1.8.6, 1.8.7 Rails 2.3.5 Rack 1.0.1
0.8.x ruby 1.8.6, 1.8.7 Rails 2.1.2

Redmineの公式リリースはvendorディレクトリ以下に必要なバージョンのRailsが含まれています。したがって、Ruby on Railsを別途インストールを行う必要はありません。

ソースコードをRedmineのリポジトリからチェックアウトした場合は、以下の手順で適切なバージョンのRailsをインストールしてください:

gem install rails -v=2.3.5

Rackもインストールします。

gem install rack -v=1.0.1

注意:

  • Ruby 1.9には対応していません。 上記の表に示したバージョンのRuby 1.8.xをインストールしてください。
  • RubyGems 1.3.1以上が必要です。
  • Rake 0.8.3以上が必要です。
  • Rack 1.0.1が必要です。1.0.1がインストールされていない場合、データベースマイグレーションが失敗します。

データベース

  • MySQL 5.0以上 (推奨)
    • MySQLのC bindingをインストールしてください。劇的にパフォーマンスが改善します。インストールを行うには gem install mysql を実行してください。
  • PostgreSQL 8
    • データベースの日付形式がISO(PostgreSQLのデフォルト)であることを確認してください。次のSQL文で設定できます: ALTER DATABASE "redmine_db" SET datestyle="ISO,MDY";
    • PostgreSQL 8.4.0 と 8.4.1 に存在するバグがRedmineの動作に影響を及ぼします。(<a href="http://www.redmine.org/issues/4259">#4259</a>, <a href="http://www.redmine.org/issues/4314">#4314</a>) PostgreSQL 8.4.2では修正されています。
    • 次のいずれかのコマンドを実行してRuby用のPosgreSQLアダプタをインストールしてください。
      • gem install postgres-pr
      • gem install pg (works with SSL connections, may need development libraries/packages for your OS before it will compile)
        • Ubuntu OS: development libraries can be installed with (or similiar): sudo aptitude install libdbd-pg-ruby1.8
  • SQLite 3

オプション

  • svn等のSCMバイナリ(リポジトリ閲覧用、PATHが通っていなければなりません)。 使用できるSCMや必要となるものについては 「リポジトリの設定」 をご覧下さい。
  • RMagick (ガントチャートのPNG形式でのエクスポートで使用)
  • Ruby OpenID Library (OpenIDによる認証を使用する場合) [OpenIDはtrunkと0.9-devのみで利用可能] バージョン2以降

Redmineのバージョン

大多数のユーザーにはリリース版のRedmineをインストールするのがおすすめです。Redmineは現在6ヶ月ごとに新しいバージョンがリリースされており、リリース版はたいへん実用的でかつ安定しています。RubyおよびRailsに精通しているのでなければ、trunkバージョンのRedmineの利用はおすすめできません。trunkバージョンは正常に動作しないこともあります。

インストール

1. Redmineのアーカイブを ダウンロード し展開するか、svnリポジトリからチェックアウトしてください。

2. 空のデータベースとそのデータベースに接続するためのユーザーを作成してください。(例えば redmine )

MySQLの場合:

create database redmine character set utf8;
create user 'redmine'@'localhost' identified by 'my_password';
grant all privileges on redmine.* to 'redmine'@'localhost';

PostgreSQLの場合:

CREATE ROLE redmine LOGIN ENCRYPTED PASSWORD 'my_password' NOINHERIT VALID UNTIL 'infinity';
CREATE DATABASE redmine WITH ENCODING='UTF8' OWNER=redmine;

3. config/database.example.yml をコピーして config/database.yml を作成してください。 config/database.yml を編集し、"production"環境用のデータベース設定を行ってください。

MySQLの場合の例です:

production:
  adapter: mysql
  database: redmine
  host: localhost
  username: redmine
  password: my_password

MySQLを標準のポート(3306)以外で実行している場合は以下のような設定となります:

production:
adapter: mysql
database: redmine
host: localhost
port: 3307
username: redmine
password: my_password

PostgreSQLを使用する場合の例(デフォルトのポート):

production:
adapter: postgresql
database: <your_database_name>
host: <postgres_host>
username: <postgres_user>
password: <postgres_user_password>
encoding: utf8
schema_search_path: <database_schema> (default - public)

4. セッションストア秘密鍵を生成してください。この手順はRedmine r2493以降の trunk またはRedmine 0.8.7以降を利用する場合に必要です。

rake config/initializers/session_store.rb

5. 下記コマンドを$RAILS_ROOTで実行し、データベース上にテーブルを作成します:

rake db:migrate RAILS_ENV="production" 

これによりテーブルとRedmineの管理者アカウントが作成されます。

もしUbuntuで次のエラーが発生した場合、libopenssl-ruby1.8が必要です。

Rake aborted!
no such file to load -- net/https

以下のコマンドを実行してください。

apt-get install libopenssl-ruby1.8

6. 下記コマンドを実行し、デフォルトのデータをデータベースに登録してください:

rake redmine:load_default_data RAILS_ENV="production" 

この手順の実行は任意ですが 強く推奨されます。 これによりデフォルトのロール、トラッカー、ステータス、ワークフロー、列挙項目がロードされます。

7. パーミッションの設定

Windows上で実行する場合はこの手順は省略してください。

Redminを実行するユーザーは次のディレクトリに対して書き込み権限が必要です: files, log, tmp (tmpが無ければ作成してください)。

mkdir tmp public/plugin_assets 
sudo chown -R redmine:redmine files log tmp public/plugin_assets
sudo chmod -R 755 files log tmp public/plugin_assets

8. WEBrickによるwebサーバを起動して、インストールができたかテストしてください:

ruby script/server webrick -e production

WEBrickが起動したら、ブラウザで http://localhost:3000/ を開いてください。Redmineのwelcomeページが表示されるはずです。

注意: Webrickは通常は開発時に使用すものであり、通常の運用には適していません。動作確認以外には使用しないでください。本番運用においてはPassenger (mod_rails) や mongrel の利用を検討してください。

9. デフォルトの管理者アカウントでログインしてください。:

  • login: admin
  • password: admin

「管理」画面でアプリケーションの設定を変更できます。

ログの設定

Redmineはデフォルトでは:infoレベルのログをlogディレクトリに記録します。サイトの利用状況によってはファイルサイズが大きくなるので、ログファイルが無制限に大きくならないようログのローテーションを行うことを検討してください。logrotateのようなシステムユーティリティを使用するか、config/additional_environment.rbによりローテーションが行えます。

後者の方法でローテーションを行うには、config/additional_environment.rb.exampleファイルをコピーしてconfig/additional_environment.rbファイルを作成し、下記の行を追加してください。loggerのデフォルトのログレベルはLogger::DEBUGであり大量の情報が記録されるので、明示的にLogger::INFOレベルに設定する必要があるので注意してください。

#Logger.new(PATH,NUM_FILES_TO_ROTATE,FILE_SIZE)
config.logger = Logger.new(config.log_path, 2, 1000000)
config.logger.level = Logger::INFO

SMTPサーバの設定

config/email.yml.example をコピーして config/email.yml を作成して編集を行い、SMTP設定を適宜調整してください。

設定例は メールの設定 を参照してください。

設定変更後は必ずサーバを再起動してください。

バックアップ

以下をバックアップしてください:

  • データ (Redmineのデータベースに蓄積されています)
  • 添付ファイル (Redmineのインストールディレクトリのfilesディレクトリ以下)

簡単なバックアップスクリプトの例を示します (mysqlを使用している場合):

# Database
/usr/bin/mysqldump -u <username> -p <password> <redmine_database> | gzip > /path/to/backup/db/redmine_`date +%y_%m_%d`.gz

# Attachments
rsync -a /path/to/redmine/files /path/to/backup/files

Windows環境でのインストール

RubyInstaller をインストール後、スタートメニューから「Start Command Prompt with Ruby」を実行してください。

開いたコマンドプロンプト内で、前述の手順を実行してください。

ただし、一部のコマンドはそのままではWindows上では実行できませんので次のように変更してください。

変更前:

RAILS_ENV=production rake db:migrate
RAILS_ENV=production rake redmine:load_default_data

変更後:

set RAILS_ENV=production
rake db:migrate
rake redmine:load_default_data

データベースにMySQLを使う場合は次のコマンドを実行してMySQLのgemをインストールしてください。

gem install mysql

場合によってはlibmysql.dllをruby/binディレクトリにコピーすることが必要です。libmysql.dllはどれでもよいわけではありません。次のURLのものが動作するようです。

http://instantrails.rubyforge.org/svn/trunk/InstantRails-win/InstantRails/mysql/bin/libmySQL.dll

MySQL 5.1とRails 2.2以上の組み合わせにおける問題

最新のバージョンのMySQLを使っている場合、次のようなエラーが発生することがあります。

!!! The bundled mysql.rb driver has been removed from Ruby 2.2

そして "gem install mysql" を実行すると大量のエラーが発生します。rakeタスクの実行もすぐに失敗します。

この問題を解決するにはInstantRails projectから以下のDLLをダウンロードし、\Ruby\bunディレクトリにコピーしてから再度rakeコマンドを実行してみてください。

http://instantrails.rubyforge.org/svn/trunk/InstantRails-win/InstantRails/mysql/bin/libmySQL.dll

手作業でのインストール以外の方法

インストール作業を簡略化できるサードパーティのAll-in-Oneインストーラも提供されています。 ダウンロード ページを参照してください。