Project

General

Profile

RedmineInstall » History » Version 26

Jean-Philippe Lang, 2008-12-30 13:14
Mysql c bindings

1 1 Jean-Philippe Lang
h1. Installing Redmine
2
3
{{>TOC}}
4
5
h2. Requirements
6
7 25 Jean-Philippe Lang
h3. Operating system
8 1 Jean-Philippe Lang
9 25 Jean-Philippe Lang
Redmine should run on most Unix, Linux, Mac and Windows systems as long as ruby is available on this platform.
10
11
h3. Ruby & Ruby on Rails
12
13
The required Rails version for a given Redmine version is:
14
15 20 Jean-Philippe Lang
|_. Redmine version|_. Rails version required|
16
|trunk|Rails 2.1.2|
17
|0.8.x|Rails 2.1.2|
18 1 Jean-Philippe Lang
|0.7.x|Rails 2.0.2|
19 22 Jean-Philippe Lang
20
Official releases include the appropriate Rails version in their @vendor@ directory. So no particular action is needed.
21 1 Jean-Philippe Lang
If you checkout the source from the Redmine repository, you can install a specific Rails version on your machine by running:
22 22 Jean-Philippe Lang
23 1 Jean-Philippe Lang
  gem install rails -v=2.1.2
24
25 25 Jean-Philippe Lang
Notes:
26
* Rails has some compatibility issues with ruby 1.8.7. *The supported ruby version is 1.8.6*.
27
* *Rails 2.2.x is not supported* for now.
28 1 Jean-Philippe Lang
29 25 Jean-Philippe Lang
h3. Database
30
31 24 Jean-Philippe Lang
      * MySQL 4.1 or higher (recommended)
32 1 Jean-Philippe Lang
      * PostgreSQL 8
33
      * SQLite 3 (please read this: http://weblog.rubyonrails.org/2007/1/29/using-sqlite3-with-rails)
34 22 Jean-Philippe Lang
35 26 Jean-Philippe Lang
If you're using a MySQL database, make sure to install the C bindings that dramatically improve performance. You can get them by running @gem install mysql@.
36
37 25 Jean-Philippe Lang
h3. Optional components
38 23 Jean-Philippe Lang
39 25 Jean-Philippe Lang
      * SCM binaries (eg. @svn@), for repository browsing (must be available in your PATH). See [[RedmineRepositories]] for SCM compatibility and requirements.
40
      * "RMagick":http://rmagick.rubyforge.org/ (to enable Gantt export to png image)
41 1 Jean-Philippe Lang
42
43 8 Thomas Lecavelier
h2. Installation
44 1 Jean-Philippe Lang
45 6 Jean-Philippe Lang
1. [[Download]] and extract the archive or [[CheckingoutRedmine|checkout]] Redmine.
46
47
2. Create an empty database named @redmine@ for example.
48
49
For MySQL:
50 1 Jean-Philippe Lang
51 9 Jean-Philippe Lang
  create database redmine character set utf8;
52 1 Jean-Philippe Lang
53 3 Jean-Philippe Lang
3. Copy @config/database.yml.example@ to @config/database.yml@ and edit this file in order to configure your database settings for "production" environment.
54 1 Jean-Philippe Lang
55 14 Jean-Philippe Lang
Example for a MySQL database:
56
57
<pre>
58
production:
59
  adapter: mysql
60
  database: redmine
61
  host: localhost
62
  username: bduser
63 3 Jean-Philippe Lang
  password: bdpasswd
64
</pre>
65
66 1 Jean-Philippe Lang
4. Create the database structure, by running the following command under the application root directory:
67
68
  rake db:migrate RAILS_ENV="production"
69
70 3 Jean-Philippe Lang
It will create tables and an administrator account.
71 1 Jean-Philippe Lang
72
5. Insert default configuration data in database, by running the following command:
73
74
  rake redmine:load_default_data RAILS_ENV="production"
75
76 14 Jean-Philippe Lang
This step is optional but *highly recommended*, as you can define your own configuration from scratch. It will load default roles, trackers, statuses, workflows and enumerations.
77 1 Jean-Philippe Lang
78 18 Thomas Lecavelier
6. Setting up permissions
79
80 14 Jean-Philippe Lang
NB: _Windows users have to skip this section._
81
82
The user who runs Redmine must have write permission on the following subdirectories: @files@, @log@, @tmp@ (create the last one if not present).
83
84
Assuming you run Redmine with a @redmine@ user:
85
86
<pre>
87
mkdir tmp
88
sudo chown -R redmine:redmine files log tmp
89
sudo chmod -R 755 files log tmp
90
</pre>
91
92 1 Jean-Philippe Lang
7. Test the installation by running WEBrick web server:
93
94
  ruby script/server -e production
95
96 14 Jean-Philippe Lang
Once WEBrick has started, point your browser to http://localhost:3000/. You should now see the application welcome page.
97 1 Jean-Philippe Lang
98
8. Use default administrator account to log in:
99
100
    * login: admin
101 14 Jean-Philippe Lang
    * password: admin
102 1 Jean-Philippe Lang
103
You can go to @Admin & Settings@ to modify application settings.
104
105 21 Jean-Philippe Lang
h2. SMTP server Configuration
106
107
h3. 0.8.x releases
108
109
Copy @config/email.yml.example@ to @config/email.yml@ and edit this file to adjust your SMTP settings.
110
111 1 Jean-Philippe Lang
h3. 0.7.x releases
112
113
In config/environment.rb, you can set parameters for your SMTP server:
114
115
    * config.action_mailer.smtp_settings: SMTP server configuration
116 7 Thomas Lecavelier
    * config.action_mailer.perform_deliveries: set to false to disable mail delivering
117 11 Jean-Philippe Lang
118
Don't forget to restart the application after any change.
119
120
h2. Backups
121
122
Redmine backups should include:
123
* data (stored in your redmine database)
124
* attachments (stored in the @files@ directory of your Redmine install)
125
126
Here is a simple shell script that can be used for daily backups (assuming you're using a mysql database):
127
128
<pre>
129
# Database
130
/usr/bin/mysqldump -u <username> -p <password> <redmine_database> | gzip > /path/to/backup/db/redmine_`date +%y_%m_%d`.gz
131
132
# Attachments
133 1 Jean-Philippe Lang
rsync -a /path/to/redmine/files /path/to/backup/files
134
</pre>