INSTALL
71 lines
| 2.0 KiB
| text/plain
|
TextLexer
/ doc / INSTALL
Jean-Philippe Lang
|
r2 | == redMine installation | ||
| redMine - project management software | ||||
|
Jean-Philippe Lang
|
r138 | Copyright (C) 2006-2007 Jean-Philippe Lang | ||
| http://redmine.rubyforge.org/ | ||||
|
Jean-Philippe Lang
|
r2 | |||
| == Requirements | ||||
| * Ruby on Rails 1.1 | ||||
|
Jean-Philippe Lang
|
r24 | * Iconv | ||
|
Jean-Philippe Lang
|
r138 | * A database (see compatibility below) | ||
|
Jean-Philippe Lang
|
r2 | |||
|
Jean-Philippe Lang
|
r42 | Optional: | ||
|
Jean-Philippe Lang
|
r140 | * RedCloth (to enable textile formatting) | ||
|
Jean-Philippe Lang
|
r5 | |||
|
Jean-Philippe Lang
|
r42 | Supported databases: | ||
|
Jean-Philippe Lang
|
r5 | * MySQL (tested with MySQL 5) | ||
| * PostgreSQL (tested with PostgreSQL 8.1) | ||||
| * Oracle (tested with Oracle 10g) | ||||
| * SQL Server (tested with SQL Server 2005) | ||||
| * SQLite (tested with SQLite 3) | ||||
|
Jean-Philippe Lang
|
r42 | |||
|
Jean-Philippe Lang
|
r2 | == Installation | ||
| 1. Uncompress program archive: | ||||
| tar zxvf <filename> | ||||
| 2. Create an empty database: "redmine" for example | ||||
| 3. Configure database parameters in config/database.yml | ||||
|
Jean-Philippe Lang
|
r5 | for "production" environment (default database is MySQL) | ||
|
Jean-Philippe Lang
|
r2 | |||
|
Jean-Philippe Lang
|
r138 | 4. Create the database structure. Under the application main directory: | ||
|
Jean-Philippe Lang
|
r2 | rake migrate RAILS_ENV="production" | ||
|
Jean-Philippe Lang
|
r138 | It will create tables and an administrator account. | ||
|
Jean-Philippe Lang
|
r2 | |||
|
Jean-Philippe Lang
|
r25 | 5. Insert default configuration data in database: | ||
| rake load_default_data RAILS_ENV="production" | ||||
|
Jean-Philippe Lang
|
r138 | It will load default roles, trackers, statuses, workflows and enumerations. | ||
| This step is optional (but recommended), as you can define your | ||||
| own configuration from sratch. | ||||
|
Jean-Philippe Lang
|
r25 | |||
| 6. Test the installation by running WEBrick web server: | ||||
|
Jean-Philippe Lang
|
r2 | ruby script/server -e production | ||
| Once WEBrick has started, point your browser to http://localhost:3000/ | ||||
| You should now see the application welcome page | ||||
|
Jean-Philippe Lang
|
r25 | 7. Use default administrator account to log in: | ||
|
Jean-Philippe Lang
|
r2 | login: admin | ||
| password: admin | ||||
|
Jean-Philippe Lang
|
r25 | 8. Setup Apache or Lighttpd with fastcgi for best performance. | ||
|
Jean-Philippe Lang
|
r2 | |||
| == Configuration | ||||
|
Jean-Philippe Lang
|
r10 | A sample configuration file is provided: "config/config_custom.example.rb" | ||
|
Jean-Philippe Lang
|
r140 | Rename it to config_custom.rb and set your parameters. | ||
|
Jean-Philippe Lang
|
r2 | Don't forget to restart the application after any change. | ||
|
Jean-Philippe Lang
|
r140 | In config/environment.rb, you can set parameters for your SMTP server: | ||
|
Jean-Philippe Lang
|
r2 | config.action_mailer.server_settings: SMTP server configuration | ||
| config.action_mailer.perform_deliveries: set to false to disable mail delivering | ||||
|
Jean-Philippe Lang
|
r140 | |||
| == Upgrading | ||||
| See UPGRADING | ||||