INSTALL
97 lines
| 2.9 KiB
| text/plain
|
TextLexer
/ doc / INSTALL
|
r870 | == Redmine installation | ||
Redmine - project management software | ||||
|
r5845 | Copyright (C) 2006-2011 Jean-Philippe Lang | ||
|
r870 | http://www.redmine.org/ | ||
== Requirements | ||||
|
r3309 | * Ruby 1.8.6 or 1.8.7 | ||
|
r5845 | * RubyGems 1.3.7 | ||
|
r4453 | |||
|
r7729 | * Ruby on Rails 2.3.14 (official downloadable Redmine releases are packaged with | ||
|
r3309 | the appropriate Rails version) | ||
|
r3734 | |||
|
r7729 | * Rack 1.1.2 gem | ||
|
r3734 | |||
|
r7729 | * Rake 0.9.2 gem | ||
|
r3734 | |||
|
r4453 | * I18n 0.4.2 gem | ||
|
r3734 | |||
|
r1610 | * A database: | ||
|
r5845 | * MySQL (tested with MySQL 5.1) | ||
* PostgreSQL (tested with PostgreSQL 8.4) | ||||
* SQLite3 (tested with SQLite 3.6) | ||||
|
r870 | |||
Optional: | ||||
|
r3734 | * 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) | ||||
|
r870 | |||
== Installation | ||||
1. Uncompress the program archive | ||||
|
r3734 | |||
|
r870 | 2. Create an empty database: "redmine" for example | ||
|
r3734 | 3. Configure the database parameters in config/database.yml | ||
for the "production" environment (default database is MySQL) | ||||
|
r870 | |||
|
r3341 | 4. Generate a session store secret | ||
|
r3734 | |||
|
r2433 | Redmine stores session data in cookies by default, which requires | ||
|
r3734 | a secret to be generated. Under the application main directory run: | ||
rake generate_session_store | ||||
5. Create the database structure | ||||
|
r3341 | |||
|
r3734 | Under the application main directory run: | ||
rake db:migrate RAILS_ENV="production" | ||||
|
r3341 | |||
|
r3734 | It will create all the tables and an administrator account. | ||
|
r1532 | |||
|
r3734 | 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 | ||||
|
r1532 | |||
|
r3734 | 7. Test the installation by running the WEBrick web server | ||
Under the main application directory run: | ||||
ruby script/server -e production | ||||
|
r870 | Once WEBrick has started, point your browser to http://localhost:3000/ | ||
|
r3734 | You should now see the application welcome page. | ||
|
r870 | |||
|
r3734 | 8. Use the default administrator account to log in: | ||
|
r870 | login: admin | ||
password: admin | ||||
|
r3734 | Go to "Administration" to load the default configuration data (roles, | ||
trackers, statuses, workflow) and to adjust the application settings | ||||
|
r870 | |||
|
r3734 | == SMTP server Configuration | ||
|
r870 | |||
|
r4632 | Copy config/configuration.yml.example to config/configuration.yml and | ||
edit this file to adjust your SMTP settings. | ||||
|
r3734 | Do not forget to restart the application after any change to this file. | ||
|
r1611 | |||
Please do not enter your SMTP settings in environment.rb. | ||||
|
r3734 | |||
== 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 | ||||