annotate .svn/pristine/ab/ab114f5adab85b76c8331bf71ea599dc558c656f.svn-base @ 1621:3a510bf6a9bc

Merge from live branch
author Chris Cannam
date Fri, 13 Jul 2018 10:44:33 +0100
parents e248c7af89ec
children
rev   line source
Chris@1494 1 == Redmine installation
Chris@1494 2
Chris@1494 3 Redmine - project management software
Chris@1494 4 Copyright (C) 2006-2014 Jean-Philippe Lang
Chris@1494 5 http://www.redmine.org/
Chris@1494 6
Chris@1494 7
Chris@1494 8 == Requirements
Chris@1494 9
Chris@1494 10 * Ruby 1.8.7, 1.9.2, 1.9.3 or 2.0.0
Chris@1494 11 * RubyGems
Chris@1494 12 * Bundler >= 1.0.21
Chris@1494 13
Chris@1494 14 * A database:
Chris@1494 15 * MySQL (tested with MySQL 5.1)
Chris@1494 16 * PostgreSQL (tested with PostgreSQL 9.1)
Chris@1494 17 * SQLite3 (tested with SQLite 3.7)
Chris@1494 18 * SQLServer (tested with SQLServer 2012)
Chris@1494 19
Chris@1494 20 Optional:
Chris@1494 21 * SCM binaries (e.g. svn, git...), for repository browsing (must be available in PATH)
Chris@1494 22 * ImageMagick (to enable Gantt export to png images)
Chris@1494 23
Chris@1494 24 == Installation
Chris@1494 25
Chris@1494 26 1. Uncompress the program archive
Chris@1494 27
Chris@1494 28 2. Create an empty utf8 encoded database: "redmine" for example
Chris@1494 29
Chris@1494 30 3. Configure the database parameters in config/database.yml
Chris@1494 31 for the "production" environment (default database is MySQL and ruby1.9)
Chris@1494 32
Chris@1494 33 If you're running Redmine with MySQL and ruby1.8, replace the adapter name
Chris@1494 34 with `mysql`
Chris@1494 35
Chris@1494 36 4. Install the required gems by running:
Chris@1494 37 bundle install --without development test
Chris@1494 38
Chris@1494 39 If ImageMagick is not installed on your system, you should skip the installation
Chris@1494 40 of the rmagick gem using:
Chris@1494 41 bundle install --without development test rmagick
Chris@1494 42
Chris@1494 43 Only the gems that are needed by the adapters you've specified in your database
Chris@1494 44 configuration file are actually installed (eg. if your config/database.yml
Chris@1494 45 uses the 'mysql2' adapter, then only the mysql2 gem will be installed). Don't
Chris@1494 46 forget to re-run `bundle install` when you change config/database.yml for using
Chris@1494 47 other database adapters.
Chris@1494 48
Chris@1494 49 If you need to load some gems that are not required by Redmine core (eg. fcgi),
Chris@1494 50 you can create a file named Gemfile.local at the root of your redmine directory.
Chris@1494 51 It will be loaded automatically when running `bundle install`.
Chris@1494 52
Chris@1494 53 5. Generate a session store secret
Chris@1494 54
Chris@1494 55 Redmine stores session data in cookies by default, which requires
Chris@1494 56 a secret to be generated. Under the application main directory run:
Chris@1494 57 rake generate_secret_token
Chris@1494 58
Chris@1494 59 6. Create the database structure
Chris@1494 60
Chris@1494 61 Under the application main directory run:
Chris@1494 62 rake db:migrate RAILS_ENV="production"
Chris@1494 63
Chris@1494 64 It will create all the tables and an administrator account.
Chris@1494 65
Chris@1494 66 7. Setting up permissions (Windows users have to skip this section)
Chris@1494 67
Chris@1494 68 The user who runs Redmine must have write permission on the following
Chris@1494 69 subdirectories: files, log, tmp & public/plugin_assets.
Chris@1494 70
Chris@1494 71 Assuming you run Redmine with a user named "redmine":
Chris@1494 72 sudo chown -R redmine:redmine files log tmp public/plugin_assets
Chris@1494 73 sudo chmod -R 755 files log tmp public/plugin_assets
Chris@1494 74
Chris@1494 75 8. Test the installation by running the WEBrick web server
Chris@1494 76
Chris@1494 77 Under the main application directory run:
Chris@1494 78 ruby script/rails server -e production
Chris@1494 79
Chris@1494 80 Once WEBrick has started, point your browser to http://localhost:3000/
Chris@1494 81 You should now see the application welcome page.
Chris@1494 82
Chris@1494 83 9. Use the default administrator account to log in:
Chris@1494 84 login: admin
Chris@1494 85 password: admin
Chris@1494 86
Chris@1494 87 Go to "Administration" to load the default configuration data (roles,
Chris@1494 88 trackers, statuses, workflow) and to adjust the application settings
Chris@1494 89
Chris@1494 90 == SMTP server Configuration
Chris@1494 91
Chris@1494 92 Copy config/configuration.yml.example to config/configuration.yml and
Chris@1494 93 edit this file to adjust your SMTP settings.
Chris@1494 94 Do not forget to restart the application after any change to this file.
Chris@1494 95
Chris@1494 96 Please do not enter your SMTP settings in environment.rb.
Chris@1494 97
Chris@1494 98 == References
Chris@1494 99
Chris@1494 100 * http://www.redmine.org/wiki/redmine/RedmineInstall
Chris@1494 101 * http://www.redmine.org/wiki/redmine/EmailConfiguration
Chris@1494 102 * http://www.redmine.org/wiki/redmine/RedmineSettings
Chris@1494 103 * http://www.redmine.org/wiki/redmine/RedmineRepositories
Chris@1494 104 * http://www.redmine.org/wiki/redmine/RedmineReceivingEmails
Chris@1494 105 * http://www.redmine.org/wiki/redmine/RedmineReminderEmails
Chris@1494 106 * http://www.redmine.org/wiki/redmine/RedmineLDAP