diff doc/INSTALL @ 1115:433d4f72a19b redmine-2.2

Update to Redmine SVN revision 11137 on 2.2-stable branch
author Chris Cannam
date Mon, 07 Jan 2013 12:01:42 +0000
parents cbb26bc654de
children 622f24f53b42
line wrap: on
line diff
--- a/doc/INSTALL	Wed Jun 27 14:54:18 2012 +0100
+++ b/doc/INSTALL	Mon Jan 07 12:01:42 2013 +0000
@@ -1,77 +1,79 @@
 == Redmine installation
 
 Redmine - project management software
-Copyright (C) 2006-2011  Jean-Philippe Lang
+Copyright (C) 2006-2012  Jean-Philippe Lang
 http://www.redmine.org/
 
 
 == Requirements
 
-* Ruby 1.8.6 or 1.8.7
-
-* RubyGems 1.3.7
-
-* Ruby on Rails 2.3.14 (official downloadable Redmine releases are packaged with
-  the appropriate Rails version)
-
-* Rack 1.1.2 gem
-
-* Rake 0.9.2 gem
-
-* I18n 0.4.2 gem
+* Ruby 1.8.7, 1.9.2 or 1.9.3
+* RubyGems
+* Bundler >= 1.0.21
 
 * A database:
   * MySQL (tested with MySQL 5.1)
-  * PostgreSQL (tested with PostgreSQL 8.4)
+  * PostgreSQL (tested with PostgreSQL 9.1)
   * SQLite3 (tested with SQLite 3.6)
 
 Optional:
-* SCM binaries (e.g. svn), for repository browsing (must be available in PATH)
-* RMagick (to enable Gantt export to png images)
-* Ruby OpenID Library >= version 2 (to enable OpenID support)
+* SCM binaries (e.g. svn, git...), for repository browsing (must be available in PATH)
+* ImageMagick (to enable Gantt export to png images)
 
 == Installation
 
 1. Uncompress the program archive
 
-2. Create an empty database: "redmine" for example
+2. Install the required gems by running:
+     bundle install --without development test
 
-3. Configure the database parameters in config/database.yml
-   for the "production" environment (default database is MySQL)
+   If ImageMagick is not installed on your system, you should skip the installation
+   of the rmagick gem using:
+     bundle install --without development test rmagick
 
-4. Generate a session store secret
+   If you need to load some gems that are not required by Redmine core (eg. fcgi),
+   you can create a file named Gemfile.local at the root of your redmine directory.
+   It will be loaded automatically when running `bundle install`.
+
+3. Create an empty utf8 encoded database: "redmine" for example
+
+4. Configure the database parameters in config/database.yml
+   for the "production" environment (default database is MySQL and ruby1.8)
+
+   If you're running Redmine with MySQL and ruby1.9, replace the adapter name
+   with `mysql2`
+
+5. Generate a session store secret
    
    Redmine stores session data in cookies by default, which requires
    a secret to be generated. Under the application main directory run:
-     rake generate_session_store
+     rake generate_secret_token
 
-5. Create the database structure
+6. Create the database structure
    
    Under the application main directory run:
      rake db:migrate RAILS_ENV="production"
    
    It will create all the tables and an administrator account.
 
-6. Setting up permissions (Windows users have to skip this section)
+7. Setting up permissions (Windows users have to skip this section)
    
    The user who runs Redmine must have write permission on the following
-   subdirectories: files, log, tmp & public/plugin_assets (create the last
-   two if they are not yet present).
+   subdirectories: files, log, tmp & public/plugin_assets.
    
    Assuming you run Redmine with a user named "redmine":
-     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
 
-7. Test the installation by running the WEBrick web server
+8. Test the installation by running the WEBrick web server
    
    Under the main application directory run:
-     ruby script/server -e production
+     ruby script/rails server -e production
    
    Once WEBrick has started, point your browser to http://localhost:3000/
    You should now see the application welcome page.
 
-8. Use the default administrator account to log in:
+9. Use the default administrator account to log in:
    login: admin
    password: admin