INSTALL
106 lines
| 3.7 KiB
| text/plain
|
TextLexer
/ doc / INSTALL
|
r870 | == Redmine installation | ||
Redmine - project management software | ||||
|
r13491 | Copyright (C) 2006-2015 Jean-Philippe Lang | ||
|
r870 | http://www.redmine.org/ | ||
== Requirements | ||||
|
r13091 | * Ruby 1.8.7, 1.9.2, 1.9.3, 2.0 or 2.1 | ||
|
r8784 | * RubyGems | ||
* Bundler >= 1.0.21 | ||||
|
r3734 | |||
|
r1610 | * A database: | ||
|
r5845 | * MySQL (tested with MySQL 5.1) | ||
|
r10208 | * PostgreSQL (tested with PostgreSQL 9.1) | ||
|
r11427 | * SQLite3 (tested with SQLite 3.7) | ||
|
r11362 | * SQLServer (tested with SQLServer 2012) | ||
|
r870 | |||
Optional: | ||||
|
r8784 | * SCM binaries (e.g. svn, git...), for repository browsing (must be available in PATH) | ||
* ImageMagick (to enable Gantt export to png images) | ||||
|
r870 | |||
== Installation | ||||
1. Uncompress the program archive | ||||
|
r3734 | |||
|
r10973 | 2. Create an empty utf8 encoded database: "redmine" for example | ||
3. Configure the database parameters in config/database.yml | ||||
|
r10974 | for the "production" environment (default database is MySQL and ruby1.9) | ||
|
r10973 | |||
|
r10974 | If you're running Redmine with MySQL and ruby1.8, replace the adapter name | ||
with `mysql` | ||||
|
r10973 | |||
4. Install the required gems by running: | ||||
|
r8784 | bundle install --without development test | ||
If ImageMagick is not installed on your system, you should skip the installation | ||||
of the rmagick gem using: | ||||
bundle install --without development test rmagick | ||||
|
r11362 | Only the gems that are needed by the adapters you've specified in your database | ||
configuration file are actually installed (eg. if your config/database.yml | ||||
uses the 'mysql2' adapter, then only the mysql2 gem will be installed). Don't | ||||
forget to re-run `bundle install` when you change config/database.yml for using | ||||
other database adapters. | ||||
|
r9213 | If you need to load some gems that are not required by Redmine core (eg. fcgi), | ||
you can create a file named Gemfile.local at the root of your redmine directory. | ||||
It will be loaded automatically when running `bundle install`. | ||||
|
r8784 | 5. 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: | ||
|
r9494 | rake generate_secret_token | ||
|
r3734 | |||
|
r8784 | 6. 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 | |||
|
r8784 | 7. Setting up permissions (Windows users have to skip this section) | ||
|
r3734 | |||
The user who runs Redmine must have write permission on the following | ||||
|
r8784 | subdirectories: files, log, tmp & public/plugin_assets. | ||
|
r3734 | |||
Assuming you run Redmine with a user named "redmine": | ||||
sudo chown -R redmine:redmine files log tmp public/plugin_assets | ||||
sudo chmod -R 755 files log tmp public/plugin_assets | ||||
|
r1532 | |||
|
r8784 | 8. Test the installation by running the WEBrick web server | ||
|
r3734 | |||
Under the main application directory run: | ||||
|
r9513 | ruby script/rails server -e production | ||
|
r3734 | |||
|
r870 | Once WEBrick has started, point your browser to http://localhost:3000/ | ||
|
r3734 | You should now see the application welcome page. | ||
|
r870 | |||
|
r8784 | 9. 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 | ||||