doc_update_for_0.9.x_and_1.0.x-r3847.patch

SVN-patch against Redmine trunk @ r3847. - Mischa The Evil, 2010-07-18 00:33

Download (6.94 KB)

View differences:

doc/UPGRADING (working copy)
1
== Redmine upgrade procedure
1
=== Redmine upgrade
2 2

  
3 3
Redmine - project management software
4 4
Copyright (C) 2006-2010  Jean-Philippe Lang
......
8 8
== Upgrading
9 9

  
10 10
1. Uncompress the program archive in a new directory
11
   
11

  
12 12
2. Copy your database settings (RAILS_ROOT/config/database.yml)
13
   and SMTP settings (RAILS_ROOT/config/email.yml)
14
   into the new config directory
15
   DO NOT REPLACE OR EDIT ANY OTHER FILES.
13
   and SMTP settings (RAILS_ROOT/config/email.yml) into the new
14
   config directory
16 15

  
17
3. Generate a session store secret
16
3. Copy the RAILS_ROOT/files directory content into your new installation
17
   This directory contains all the attached files.
18

  
19
4. Copy the folders of the installed plugins and themes into new installation
20

  
21
5. Generate a session store secret
22
   
18 23
   Redmine stores session data in cookies by default, which requires
19
   a secret to be generated. Run:
20
   rake generate_session_store
21
      
22
4. Migrate your database (please make a backup before doing this):
23
   rake db:migrate RAILS_ENV="production"
24
   a secret to be generated. Under the new application directory run:
25
     rake generate_session_store
26
   
27
   DO NOT REPLACE OR EDIT ANY OTHER FILES.
24 28

  
25
5. Copy the RAILS_ROOT/files directory content into your new installation
26
   This directory contains all the attached files
29
6. Migrate your database
30
   
31
   Please make a backup before doing this! Under the new application
32
   directory run:
33
     rake db:migrate RAILS_ENV="production"
34
   
35
   If you have installed any plugins, you should also run their database
36
   migrations using:
37
     rake db:migrate_plugins RAILS_ENV="production"
38
   
39
   If you are upgrading to Rails 2.3.5 as part of this migration, you
40
   need to upgrade the plugin migrations before running the plugin migrations
41
   using:
42
     rake db:migrate:upgrade_plugin_migrations RAILS_ENV="production"
27 43

  
44
7. Clean up
45
   
46
   Clear the cache and the existing sessions by running:
47
     rake tmp:cache:clear
48
     rake tmp:sessions:clear
49

  
50
8. Restart the application server (e.g. mongrel, thin, passenger)
51

  
52
9. Finally go to "Administration -> Roles & permissions" to check/set permissions
53
   for new features, if any
54

  
28 55
== Notes
29 56

  
30
1. Rails 2.3.5 is required for version 0.9.
57
* Rails 2.3.5 is required for versions 0.9.x and 1.0.x.
31 58

  
32
2. When upgrading your code with svn update, don't forget to clear
33
   the application cache (RAILS_ROOT/tmp/cache) before restarting.
59
== References
60

  
61
* http://www.redmine.org/wiki/redmine/RedmineUpgrade
doc/INSTALL (working copy)
1
== Redmine installation
1
=== Redmine installation
2 2

  
3 3
Redmine - project management software
4 4
Copyright (C) 2006-2010  Jean-Philippe Lang
......
11 11

  
12 12
* Ruby on Rails 2.3.5 (official downloadable Redmine releases are packaged with
13 13
  the appropriate Rails version)
14
  
14

  
15
* Rack 1.0.1
16

  
17
* RubyGems 1.3.1
18

  
19
* Rake 0.8.3
20

  
15 21
* A database:
16 22
  * MySQL (tested with MySQL 5)
17 23
  * PostgreSQL (tested with PostgreSQL 8.1)
18 24
  * SQLite (tested with SQLite 3)
19 25

  
20 26
Optional:
21
* SVN binaries >= 1.3 (needed for repository browsing, must be available in PATH)
22
* RMagick (gantt export to png)
27
* SCM binaries (e.g. svn), for repository browsing (must be available in PATH)
28
* RMagick (to enable Gantt export to png images)
29
* Ruby OpenID Library >= version 2 (to enable OpenID support)
23 30

  
24 31
== Installation
25 32

  
26 33
1. Uncompress the program archive
27
   
34

  
28 35
2. Create an empty database: "redmine" for example
29 36

  
30
3. Configure database parameters in config/database.yml
31
   for "production" environment (default database is MySQL)
37
3. Configure the database parameters in config/database.yml
38
   for the "production" environment (default database is MySQL)
32 39

  
33 40
4. Generate a session store secret
41
   
34 42
   Redmine stores session data in cookies by default, which requires
35
   a secret to be generated. Run:
36
   rake generate_session_store
43
   a secret to be generated. Under the application main directory run:
44
     rake generate_session_store
45

  
46
5. Create the database structure
37 47
   
38
5. Create the database structure. Under the application main directory:
39
   rake db:migrate RAILS_ENV="production"
40
   It will create tables and an administrator account.
48
   Under the application main directory run:
49
     rake db:migrate RAILS_ENV="production"
41 50
   
42
6. Setting up permissions
51
   It will create all the tables and an administrator account.
52

  
53
6. Setting up permissions (Windows users have to skip this section)
54
   
43 55
   The user who runs Redmine must have write permission on the following
44
   subdirectories: files, log, tmp (create the last one if not present).
56
   subdirectories: files, log, tmp & public/plugin_assets (create the last
57
   two if they are not yet present).
58
   
59
   Assuming you run Redmine with a user named "redmine":
60
     mkdir tmp public/plugin_assets
61
     sudo chown -R redmine:redmine files log tmp public/plugin_assets
62
     sudo chmod -R 755 files log tmp public/plugin_assets
45 63

  
46
   Assuming you run Redmine with a user named redmine:
47
     mkdir tmp
48
     sudo chown -R redmine:redmine files log tmp
49
     sudo chmod -R 755 files log tmp
50

  
51
7. Test the installation by running WEBrick web server:
52
   ruby script/server -e production   
53
  
64
7. Test the installation by running the WEBrick web server
65
   
66
   Under the main application directory run:
67
     ruby script/server -e production
68
   
54 69
   Once WEBrick has started, point your browser to http://localhost:3000/
55
   You should now see the application welcome page
70
   You should now see the application welcome page.
56 71

  
57
8. Use default administrator account to log in:
72
8. Use the default administrator account to log in:
58 73
   login: admin
59 74
   password: admin
60 75
   
61
   Go to "Administration" to load the default configuration data (roles, 
62
   trackers, statuses, workflow) and adjust application settings
76
   Go to "Administration" to load the default configuration data (roles,
77
   trackers, statuses, workflow) and to adjust the application settings
63 78

  
79
== SMTP server Configuration
64 80

  
65
== Email delivery Configuration
66

  
67 81
Copy config/email.yml.example to config/email.yml and edit this file
68 82
to adjust your SMTP settings.
69
Don't forget to restart the application after any change to this file.
83
Do not forget to restart the application after any change to this file.
70 84

  
71 85
Please do not enter your SMTP settings in environment.rb.
86

  
87
== References
88

  
89
* http://www.redmine.org/wiki/redmine/RedmineInstall
90
* http://www.redmine.org/wiki/redmine/EmailConfiguration
91
* http://www.redmine.org/wiki/redmine/RedmineSettings
92
* http://www.redmine.org/wiki/redmine/RedmineRepositories
93
* http://www.redmine.org/wiki/redmine/RedmineReceivingEmails
94
* http://www.redmine.org/wiki/redmine/RedmineReminderEmails
95
* http://www.redmine.org/wiki/redmine/RedmineLDAP