Updated the INSTALL and UPGRADING documents for the 1.0 release.

Contributed by Mischa The Evil

git-svn-id: svn+ssh://rubyforge.org/var/svn/redmine/trunk@3848 e93f8b46-1217-0410-a6f0-8f06a7374b81

diff --git a/doc/INSTALL b/doc/INSTALL
index a4e4312eb4ac3f86c494cf458543e6284c88d50b..7a0e1a12f57518e826ce54d2ef4f610534c88bbe 100644 (file)
--- a/doc/INSTALL
+++ b/doc/INSTALL
@@ -11,61 +11,85 @@ http://www.redmine.org/
 
 * Ruby on Rails 2.3.5 (official downloadable Redmine releases are packaged with
   the appropriate Rails version)
-  
+
+* Rack 1.0.1
+
+* RubyGems 1.3.1
+
+* Rake 0.8.3
+
 * A database:
   * MySQL (tested with MySQL 5)
   * PostgreSQL (tested with PostgreSQL 8.1)
   * SQLite (tested with SQLite 3)
 
 Optional:
-* SVN binaries >= 1.3 (needed for repository browsing, must be available in PATH)
-* RMagick (gantt export to png)
+* 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)
 
 == Installation
 
 1. Uncompress the program archive
-   
+
 2. Create an empty database: "redmine" for example
 
-3. Configure database parameters in config/database.yml
-   for "production" environment (default database is MySQL)
+3. Configure the database parameters in config/database.yml
+   for the "production" environment (default database is MySQL)
 
 4. Generate a session store secret
+   
    Redmine stores session data in cookies by default, which requires
-   a secret to be generated. Run:
-   rake generate_session_store
+   a secret to be generated. Under the application main directory run:
+     rake generate_session_store
+
+5. Create the database structure
    
-5. Create the database structure. Under the application main directory:
-   rake db:migrate RAILS_ENV="production"
-   It will create tables and an administrator account.
+   Under the application main directory run:
+     rake db:migrate RAILS_ENV="production"
    
-6. Setting up permissions
-   The user who runs Redmine must have write permission on the following
-   subdirectories: files, log, tmp (create the last one if not present).
+   It will create all the tables and an administrator account.
 
-   Assuming you run Redmine with a user named redmine:
-     mkdir tmp
-     sudo chown -R redmine:redmine files log tmp
-     sudo chmod -R 755 files log tmp
+6. 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).
+   
+   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 WEBrick web server:
-   ruby script/server -e production   
-  
+7. Test the installation by running the WEBrick web server
+   
+   Under the main application directory run:
+     ruby script/server -e production
+   
    Once WEBrick has started, point your browser to http://localhost:3000/
-   You should now see the application welcome page
+   You should now see the application welcome page.
 
-8. Use default administrator account to log in:
+8. Use the default administrator account to log in:
    login: admin
    password: admin
    
-   Go to "Administration" to load the default configuration data (roles, 
-   trackers, statuses, workflow) and adjust application settings
-
+   Go to "Administration" to load the default configuration data (roles,
+   trackers, statuses, workflow) and to adjust the application settings
 
-== Email delivery Configuration
+== SMTP server Configuration
 
 Copy config/email.yml.example to config/email.yml and edit this file
 to adjust your SMTP settings.
-Don't forget to restart the application after any change to this file.
+Do not forget to restart the application after any change to this file.
 
 Please do not enter your SMTP settings in environment.rb.
+
+== References
+
+* http://www.redmine.org/wiki/redmine/RedmineInstall
+* http://www.redmine.org/wiki/redmine/EmailConfiguration
+* http://www.redmine.org/wiki/redmine/RedmineSettings
+* http://www.redmine.org/wiki/redmine/RedmineRepositories
+* http://www.redmine.org/wiki/redmine/RedmineReceivingEmails
+* http://www.redmine.org/wiki/redmine/RedmineReminderEmails
+* http://www.redmine.org/wiki/redmine/RedmineLDAP

diff --git a/doc/UPGRADING b/doc/UPGRADING
index a9b81d1775f51b854f18a5b73a6b2f5b1002bd8f..87f169c9d5fd8eaaaef7d41a52ecda1ac5737a3e 100644 (file)
--- a/doc/UPGRADING
+++ b/doc/UPGRADING
@@ -1,4 +1,4 @@
-== Redmine upgrade procedure
+== Redmine upgrade
 
 Redmine - project management software
 Copyright (C) 2006-2010  Jean-Philippe Lang
@@ -8,26 +8,54 @@ http://www.redmine.org/
 == Upgrading
 
 1. Uncompress the program archive in a new directory
-   
+
 2. Copy your database settings (RAILS_ROOT/config/database.yml)
-   and SMTP settings (RAILS_ROOT/config/email.yml)
-   into the new config directory
-   DO NOT REPLACE OR EDIT ANY OTHER FILES.
+   and SMTP settings (RAILS_ROOT/config/email.yml) into the new
+   config directory
+
+3. Copy the RAILS_ROOT/files directory content into your new installation
+   This directory contains all the attached files.
 
-3. Generate a session store secret
+4. Copy the folders of the installed plugins and themes into new installation
+
+5. Generate a session store secret
+   
    Redmine stores session data in cookies by default, which requires
-   a secret to be generated. Run:
-   rake generate_session_store
-      
-4. Migrate your database (please make a backup before doing this):
-   rake db:migrate RAILS_ENV="production"
+   a secret to be generated. Under the new application directory run:
+     rake generate_session_store
+   
+   DO NOT REPLACE OR EDIT ANY OTHER FILES.
 
-5. Copy the RAILS_ROOT/files directory content into your new installation
-   This directory contains all the attached files
+6. Migrate your database
+
+   If you are upgrading to Rails 2.3.5 as part of this migration, you
+   need to upgrade the plugin migrations before running the plugin migrations
+   using:
+     rake db:migrate:upgrade_plugin_migrations RAILS_ENV="production"
+   
+   Please make a backup before doing this! Under the new application
+   directory run:
+     rake db:migrate RAILS_ENV="production"
+   
+   If you have installed any plugins, you should also run their database
+   migrations using:
+     rake db:migrate_plugins RAILS_ENV="production"
+   
+7. Clean up
+   
+   Clear the cache and the existing sessions by running:
+     rake tmp:cache:clear
+     rake tmp:sessions:clear
+
+8. Restart the application server (e.g. mongrel, thin, passenger)
+
+9. Finally go to "Administration -> Roles & permissions" to check/set permissions
+   for new features, if any
 
 == Notes
 
-1. Rails 2.3.5 is required for version 0.9.
+* Rails 2.3.5 is required for versions 0.9.x and 1.0.x.
+
+== References
 
-2. When upgrading your code with svn update, don't forget to clear
-   the application cache (RAILS_ROOT/tmp/cache) before restarting.
+* http://www.redmine.org/wiki/redmine/RedmineUpgrade