Project

General

Profile

RedmineInstall » History » Version 112

Jean-Philippe Lang, 2011-01-27 23:04
Removed duplicate note about libmysql.dll

1 1 Jean-Philippe Lang
h1. Installing Redmine
2
3
{{>TOC}}
4 73 Liraz Siri
5 1 Jean-Philippe Lang
h2. Requirements
6
7 25 Jean-Philippe Lang
h3. Operating system
8 1 Jean-Philippe Lang
9 105 Josh Galvez
Redmine should run on most Unix, Linux, [[RedmineInstallOSX|Mac]], [[RedmineInstallOSXServer|Mac Server]] and Windows systems as long as Ruby is available on this platform.  See specific installation HowTos [[HowTos|here]].
10 25 Jean-Philippe Lang
11 91 Kedar Mhaswade
h3. Ruby & Ruby on Rails & Rack
12 25 Jean-Philippe Lang
13 30 Jean-Philippe Lang
The required Ruby and Ruby on Rails versions for a given Redmine version is:
14 25 Jean-Philippe Lang
15 77 Anonymous
|_. Redmine version|_. Supported Ruby versions|_. Required Rails version|_. Required Rack version|
16
|current trunk|ruby 1.8.6, 1.8.7|Rails 2.3.5|Rack 1.0.1|
17
|trunk from r2493 to r2886|ruby 1.8.6, 1.8.7|Rails 2.2.2||
18
|trunk before r2493|ruby 1.8.6, 1.8.7|Rails 2.1.2||
19 96 Felix Schäfer
|1.0.x|ruby 1.8.6, 1.8.7|Rails 2.3.5|Rack 1.0.1|
20 78 Jean-Philippe Lang
|0.9.x|ruby 1.8.6, 1.8.7|Rails 2.3.5|Rack 1.0.1|
21 77 Anonymous
|0.8.x|ruby 1.8.6, 1.8.7|Rails 2.1.2||
22 22 Jean-Philippe Lang
23
Official releases include the appropriate Rails version in their @vendor@ directory. So no particular action is needed.
24 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:
25
26 78 Jean-Philippe Lang
  gem install rails -v=2.3.5
27 1 Jean-Philippe Lang
28 91 Kedar Mhaswade
Install Rack:
29
 
30
  gem install rack -v=1.0.1
31
32 28 Jean-Philippe Lang
Notes:
33 94 Felix Schäfer
* *Ruby 1.9 is not supported yet.* You _have_ to use Ruby 1.8.x as stated above.
34 97 Holger Just
* RubyGems 1.3.1 or higher is required
35
* Rake 0.8.3 or higher is required
36 91 Kedar Mhaswade
* Rack 1.0.1 is required. If you don't have this exact version, database migration would fail.
37 111 Jean-Philippe Lang
* I18n 0.4.2 is required for Redmine >= 1.0.5
38 1 Jean-Philippe Lang
39 25 Jean-Philippe Lang
h3. Database
40
41 93 Muntek Singh
* MySQL 5.0 or higher (recommended)
42 92 Knight Samar
43 68 Mischa The Evil
 * make sure to install the C bindings for Ruby that dramatically improve performance. You can get them by running @gem install mysql@. If you have problem installing the mysql gem refer "Rails Wiki pages":http://wiki.rubyonrails.org/database-support/mysql
44 35 Jean-Philippe Lang
45
* PostgreSQL 8
46 1 Jean-Philippe Lang
47 35 Jean-Philippe Lang
 * make sure your database datestyle is set to ISO (Postgresql default setting). You can set it using: @ALTER DATABASE "redmine_db" SET datestyle="ISO,MDY";@
48 78 Jean-Philippe Lang
 * some bugs in PostgreSQL 8.4.0 and 8.4.1 affect Redmine behaviour (#4259, #4314), they are fixed in PostgreSQL 8.4.2
49 76 Randy Syring
 * make sure to install the PosgreSQL adapter for Ruby. You can get it by running (**one** of the following):
50
 **  @gem install postgres-pr@
51
 **  @gem install pg@ (works with SSL connections, may need development libraries/packages for your OS before it will compile)
52 84 Randy Syring
 *** Ubuntu OS: development libraries can be installed with (or similiar): @sudo aptitude install libdbd-pg-ruby1.8@
53 35 Jean-Philippe Lang
54
* SQLite 3
55 26 Jean-Philippe Lang
56 25 Jean-Philippe Lang
h3. Optional components
57 23 Jean-Philippe Lang
58 25 Jean-Philippe Lang
      * SCM binaries (eg. @svn@), for repository browsing (must be available in your PATH). See [[RedmineRepositories]] for SCM compatibility and requirements.
59
      * "RMagick":http://rmagick.rubyforge.org/ (to enable Gantt export to png image)
60 56 Eric Davis
      * "Ruby OpenID Library":http://openidenabled.com/ruby-openid/ (to enable OpenID support) [only on Redmine trunk / 0.9-dev]  Version 2 or greater is required.
61 1 Jean-Philippe Lang
62 107 Muntek Singh
h2. RedMine Version
63
64
It is recommended that the majority of users install the proper point releases of redmine. RedMine currently releases a new version every 6 months, and these releases are considered very usable and stable. It is *not* recommended to install redmine from trunk, unless you are deeply familier with Ruby on Rails and keep up with the changes - Trunk _does_ break from time-to-time.
65
66 8 Thomas Lecavelier
h2. Installation
67 1 Jean-Philippe Lang
68 111 Jean-Philippe Lang
1. Get the Redmine source code by either downloading a packaged release or checking out the code repository. See [[Download]].
69 6 Jean-Philippe Lang
70 36 Yclept Nemo
2. Create an empty database and accompanying user named @redmine@ for example.
71 6 Jean-Philippe Lang
72
For MySQL:
73 1 Jean-Philippe Lang
74 38 Yclept Nemo
<pre>
75 39 Yclept Nemo
create database redmine character set utf8;
76
create user 'redmine'@'localhost' identified by 'my_password';
77
grant all privileges on redmine.* to 'redmine'@'localhost';
78 38 Yclept Nemo
</pre>
79 1 Jean-Philippe Lang
80 88 Sean Farrell
For versions of MySQL prior to 5.0.2 - skip the 'create user' step and instead:
81
<pre>
82
grant all privileges on redmine.* to 'redmine'@'localhost' identified by 'my_password';
83
</pre>
84
85 63 Thanos Kyritsis
For PostgreSQL:
86
87
<pre>
88
CREATE ROLE redmine LOGIN ENCRYPTED PASSWORD 'my_password' NOINHERIT VALID UNTIL 'infinity';
89 64 Thanos Kyritsis
CREATE DATABASE redmine WITH ENCODING='UTF8' OWNER=redmine;
90 63 Thanos Kyritsis
</pre>
91
92 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.
93 1 Jean-Philippe Lang
94 14 Jean-Philippe Lang
Example for a MySQL database:
95
96
<pre>
97
production:
98
  adapter: mysql
99
  database: redmine
100
  host: localhost
101 40 Yclept Nemo
  username: redmine
102
  password: my_password
103 3 Jean-Philippe Lang
</pre>
104
105 54 Barbara Post
If your server is not running on the standard port (3306), use this configuration instead:
106
107
<pre>
108
production:
109
  adapter: mysql
110
  database: redmine
111
  host: localhost
112
  port: 3307
113
  username: redmine
114
  password: my_password
115
</pre>
116
117
118
Example for a PostgreSQL database (default port):
119 44 Alexey Lustin
120
<pre>
121
production:
122
  adapter: postgresql
123
  database: <your_database_name>
124
  host: <postgres_host>
125
  username: <postgres_user>
126 46 Istvan DEMETER
  password: <postgres_user_password>
127 1 Jean-Philippe Lang
  encoding: utf8
128 44 Alexey Lustin
  schema_search_path: <database_schema> (default - public)
129
</pre>
130
131 111 Jean-Philippe Lang
4. Generate a session store secret.
132 1 Jean-Philippe Lang
133 82 Simon Carpinter
   rake generate_session_store
134
135 41 Yclept Nemo
5. Create the database structure, by running the following command under the application root directory:
136
137 62 Vladimir L
  RAILS_ENV=production rake db:migrate
138 1 Jean-Philippe Lang
139 90 Jiongliang Zhang
140 1 Jean-Philippe Lang
It will create tables and an administrator account.
141 90 Jiongliang Zhang
142
If you get this error: 
143
<pre>
144
Rake aborted!
145
no such file to load -- net/https
146
</pre>
147
148
you need to install libopenssl-ruby1.8, in ubuntu, just like this: apt-get install libopenssl-ruby1.8
149 1 Jean-Philippe Lang
150 41 Yclept Nemo
6. Insert default configuration data in database, by running the following command:
151 1 Jean-Philippe Lang
152 62 Vladimir L
  RAILS_ENV=production rake redmine:load_default_data
153 32 Jean-Philippe Lang
154
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.
155
156
7. Setting up permissions
157
158 14 Jean-Philippe Lang
NB: _Windows users have to skip this section._
159
160
The user who runs Redmine must have write permission on the following subdirectories: @files@, @log@, @tmp@ (create the last one if not present).
161
162
Assuming you run Redmine with a @redmine@ user:
163
164 31 Eric Davis
<pre>
165 1 Jean-Philippe Lang
mkdir tmp public/plugin_assets
166 31 Eric Davis
sudo chown -R redmine:redmine files log tmp public/plugin_assets
167 14 Jean-Philippe Lang
sudo chmod -R 755 files log tmp public/plugin_assets
168
</pre>
169 1 Jean-Philippe Lang
170 32 Jean-Philippe Lang
8. Test the installation by running WEBrick web server:
171 1 Jean-Philippe Lang
172 33 Jean-Philippe Lang
  ruby script/server webrick -e production
173 1 Jean-Philippe Lang
174 14 Jean-Philippe Lang
Once WEBrick has started, point your browser to http://localhost:3000/. You should now see the application welcome page.
175 1 Jean-Philippe Lang
176 103 Muntek Singh
> Note: Webrick is *not* suitable for normal use, please only use webrick for testing that the installation up to this point is functional. It is not recommended to use webrick for anything other than development. Use one of the many other guides in this wiki to setup redmine to use either passenger (aka mod_rails) or mongrel to serve up your redmine. 
177
178 32 Jean-Philippe Lang
9. Use default administrator account to log in:
179 1 Jean-Philippe Lang
180
    * login: admin
181 14 Jean-Philippe Lang
    * password: admin
182 1 Jean-Philippe Lang
183
You can go to @Admin & Settings@ to modify application settings.
184
185 101 T. Hauptman
h2. Logger Configuration
186
187
Redmine defaults to a log level of :info, writing to the @log@ subdirectory. Depending on site usage, this can be a lot of data so to avoid the contents of the logfile growing without bound, consider rotating them, either through a system utility like @logrotate@ or via the @config/additional_environment.rb@ file.
188
189 106 Felix Schäfer
To use the latter, copy @config/additional_environment.rb.example@ to @config/additional_environment.rb@ and add the following lines. Note that the new logger defaults to a high log level and hence has to be explicitly set to @info@.
190
<pre><code class="ruby">
191 1 Jean-Philippe Lang
#Logger.new(PATH,NUM_FILES_TO_ROTATE,FILE_SIZE)
192 101 T. Hauptman
config.logger = Logger.new(config.log_path, 2, 1000000)
193 106 Felix Schäfer
config.logger.level = Logger::INFO
194
</code></pre>
195 101 T. Hauptman
196 21 Jean-Philippe Lang
h2. SMTP server Configuration
197
198 66 Henry Bernard
Copy @config/email.yml.example@ to @config/email.yml@ and edit this file to adjust your SMTP settings.
199 21 Jean-Philippe Lang
200 95 Mischa The Evil
See the [[EmailConfiguration|email configuration]] examples.
201 11 Jean-Philippe Lang
202
Don't forget to restart the application after any change.
203
204
h2. Backups
205
206
Redmine backups should include:
207
* data (stored in your redmine database)
208
* attachments (stored in the @files@ directory of your Redmine install)
209
210
Here is a simple shell script that can be used for daily backups (assuming you're using a mysql database):
211
212
<pre>
213
# Database
214 55 Lukasz Slonina
/usr/bin/mysqldump -u <username> -p<password> <redmine_database> | gzip > /path/to/backup/db/redmine_`date +%y_%m_%d`.gz
215 11 Jean-Philippe Lang
216
# Attachments
217 1 Jean-Philippe Lang
rsync -a /path/to/redmine/files /path/to/backup/files
218
</pre>
219 69 Giuliano Simoncelli
220
h2. Notes on Windows installation
221
222
Get and install rubyinstaller from http://rubyforge.org. Form start menu select _Start Command Prompt with Ruby_
223
224
In the prompt follow the instruction given before
225
226
The commands:
227
228
<pre>
229
RAILS_ENV=production rake db:migrate
230
RAILS_ENV=production rake redmine:load_default_data
231
</pre>
232
233
has to be changed in 
234
235
<pre>
236
set RAILS_ENV=production
237
rake db:migrate
238 71 Giuliano Simoncelli
rake redmine:load_default_data
239 69 Giuliano Simoncelli
</pre>  
240
241 70 Giuliano Simoncelli
You may need to install install the mysql gem, with the command
242 69 Giuliano Simoncelli
243
<pre>
244
gem install mysql
245 1 Jean-Philippe Lang
</pre>
246
247
And in some case is required to copy the libmysql.dll file in your ruby/bin directory.
248
Not all libmysql.dll are ok this seem to works http://instantrails.rubyforge.org/svn/trunk/InstantRails-win/InstantRails/mysql/bin/libmySQL.dll
249 80 Jean-Philippe Lang
250
h2. Alternative to manual installation
251
252
Some users may prefer to skip manual installation by using one of the [[Download#Third-party-Redmine-bundles|third-party Redmine bundles]] on the download page.