annotate .svn/pristine/7f/7f793d123c11e16acd2d74a86ee6e86fa59cf1d2.svn-base @ 1327:287f201c2802 redmine-2.2-integration

Add italic
author Chris Cannam <chris.cannam@soundsoftware.ac.uk>
date Wed, 19 Jun 2013 20:56:22 +0100
parents cbb26bc654de
children
rev   line source
Chris@909 1 == Redmine installation
Chris@909 2
Chris@909 3 Redmine - project management software
Chris@909 4 Copyright (C) 2006-2011 Jean-Philippe Lang
Chris@909 5 http://www.redmine.org/
Chris@909 6
Chris@909 7
Chris@909 8 == Requirements
Chris@909 9
Chris@909 10 * Ruby 1.8.6 or 1.8.7
Chris@909 11
Chris@909 12 * RubyGems 1.3.7
Chris@909 13
Chris@909 14 * Ruby on Rails 2.3.14 (official downloadable Redmine releases are packaged with
Chris@909 15 the appropriate Rails version)
Chris@909 16
Chris@909 17 * Rack 1.1.2 gem
Chris@909 18
Chris@909 19 * Rake 0.9.2 gem
Chris@909 20
Chris@909 21 * I18n 0.4.2 gem
Chris@909 22
Chris@909 23 * A database:
Chris@909 24 * MySQL (tested with MySQL 5.1)
Chris@909 25 * PostgreSQL (tested with PostgreSQL 8.4)
Chris@909 26 * SQLite3 (tested with SQLite 3.6)
Chris@909 27
Chris@909 28 Optional:
Chris@909 29 * SCM binaries (e.g. svn), for repository browsing (must be available in PATH)
Chris@909 30 * RMagick (to enable Gantt export to png images)
Chris@909 31 * Ruby OpenID Library >= version 2 (to enable OpenID support)
Chris@909 32
Chris@909 33 == Installation
Chris@909 34
Chris@909 35 1. Uncompress the program archive
Chris@909 36
Chris@909 37 2. Create an empty database: "redmine" for example
Chris@909 38
Chris@909 39 3. Configure the database parameters in config/database.yml
Chris@909 40 for the "production" environment (default database is MySQL)
Chris@909 41
Chris@909 42 4. Generate a session store secret
Chris@909 43
Chris@909 44 Redmine stores session data in cookies by default, which requires
Chris@909 45 a secret to be generated. Under the application main directory run:
Chris@909 46 rake generate_session_store
Chris@909 47
Chris@909 48 5. Create the database structure
Chris@909 49
Chris@909 50 Under the application main directory run:
Chris@909 51 rake db:migrate RAILS_ENV="production"
Chris@909 52
Chris@909 53 It will create all the tables and an administrator account.
Chris@909 54
Chris@909 55 6. Setting up permissions (Windows users have to skip this section)
Chris@909 56
Chris@909 57 The user who runs Redmine must have write permission on the following
Chris@909 58 subdirectories: files, log, tmp & public/plugin_assets (create the last
Chris@909 59 two if they are not yet present).
Chris@909 60
Chris@909 61 Assuming you run Redmine with a user named "redmine":
Chris@909 62 mkdir tmp public/plugin_assets
Chris@909 63 sudo chown -R redmine:redmine files log tmp public/plugin_assets
Chris@909 64 sudo chmod -R 755 files log tmp public/plugin_assets
Chris@909 65
Chris@909 66 7. Test the installation by running the WEBrick web server
Chris@909 67
Chris@909 68 Under the main application directory run:
Chris@909 69 ruby script/server -e production
Chris@909 70
Chris@909 71 Once WEBrick has started, point your browser to http://localhost:3000/
Chris@909 72 You should now see the application welcome page.
Chris@909 73
Chris@909 74 8. Use the default administrator account to log in:
Chris@909 75 login: admin
Chris@909 76 password: admin
Chris@909 77
Chris@909 78 Go to "Administration" to load the default configuration data (roles,
Chris@909 79 trackers, statuses, workflow) and to adjust the application settings
Chris@909 80
Chris@909 81 == SMTP server Configuration
Chris@909 82
Chris@909 83 Copy config/configuration.yml.example to config/configuration.yml and
Chris@909 84 edit this file to adjust your SMTP settings.
Chris@909 85 Do not forget to restart the application after any change to this file.
Chris@909 86
Chris@909 87 Please do not enter your SMTP settings in environment.rb.
Chris@909 88
Chris@909 89 == References
Chris@909 90
Chris@909 91 * http://www.redmine.org/wiki/redmine/RedmineInstall
Chris@909 92 * http://www.redmine.org/wiki/redmine/EmailConfiguration
Chris@909 93 * http://www.redmine.org/wiki/redmine/RedmineSettings
Chris@909 94 * http://www.redmine.org/wiki/redmine/RedmineRepositories
Chris@909 95 * http://www.redmine.org/wiki/redmine/RedmineReceivingEmails
Chris@909 96 * http://www.redmine.org/wiki/redmine/RedmineReminderEmails
Chris@909 97 * http://www.redmine.org/wiki/redmine/RedmineLDAP