summaryrefslogtreecommitdiffstats
path: root/doc
diff options
context:
space:
mode:
authorJean-Philippe Lang <jp_lang@yahoo.fr>2012-02-19 14:30:46 +0000
committerJean-Philippe Lang <jp_lang@yahoo.fr>2012-02-19 14:30:46 +0000
commit9315039e0a95b0234b7736f359fc039550f45e08 (patch)
treea96bd2888004e027b5e460066c3e8e42d8e6e559 /doc
parent37575f27feb19396671e6760b578265f841de733 (diff)
downloadredmine-9315039e0a95b0234b7736f359fc039550f45e08.tar.gz
redmine-9315039e0a95b0234b7736f359fc039550f45e08.zip
Use Bundler for gem management (#5638).
git-svn-id: svn+ssh://rubyforge.org/var/svn/redmine/trunk@8904 e93f8b46-1217-0410-a6f0-8f06a7374b81
Diffstat (limited to 'doc')
-rw-r--r--doc/INSTALL45
-rw-r--r--doc/RUNNING_TESTS5
-rw-r--r--doc/UPGRADING27
3 files changed, 37 insertions, 40 deletions
diff --git a/doc/INSTALL b/doc/INSTALL
index e9ae32b95..f8b6babc2 100644
--- a/doc/INSTALL
+++ b/doc/INSTALL
@@ -1,24 +1,15 @@
== Redmine installation
Redmine - project management software
-Copyright (C) 2006-2011 Jean-Philippe Lang
+Copyright (C) 2006-2012 Jean-Philippe Lang
http://www.redmine.org/
== Requirements
* Ruby 1.8.6 or 1.8.7
-
-* RubyGems 1.3.7
-
-* Ruby on Rails 2.3.14 (official downloadable Redmine releases are packaged with
- the appropriate Rails version)
-
-* Rack 1.1.2 gem
-
-* Rake 0.9.2 gem
-
-* I18n 0.4.2 gem
+* RubyGems
+* Bundler >= 1.0.21
* A database:
* MySQL (tested with MySQL 5.1)
@@ -26,44 +17,48 @@ http://www.redmine.org/
* SQLite3 (tested with SQLite 3.6)
Optional:
-* 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)
+* SCM binaries (e.g. svn, git...), for repository browsing (must be available in PATH)
+* ImageMagick (to enable Gantt export to png images)
== Installation
1. Uncompress the program archive
-2. Create an empty database: "redmine" for example
+2. Install the required gems by running:
+ 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
+
+3. Create an empty utf8 encoded database: "redmine" for example
-3. Configure the database parameters in config/database.yml
+4. Configure the database parameters in config/database.yml
for the "production" environment (default database is MySQL)
-4. Generate a session store secret
+5. Generate a session store secret
Redmine stores session data in cookies by default, which requires
a secret to be generated. Under the application main directory run:
rake generate_session_store
-5. Create the database structure
+6. Create the database structure
Under the application main directory run:
rake db:migrate RAILS_ENV="production"
It will create all the tables and an administrator account.
-6. Setting up permissions (Windows users have to skip this section)
+7. 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).
+ subdirectories: files, log, tmp & public/plugin_assets.
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
-7. Test the installation by running the WEBrick web server
+8. Test the installation by running the WEBrick web server
Under the main application directory run:
ruby script/server -e production
@@ -71,7 +66,7 @@ Optional:
Once WEBrick has started, point your browser to http://localhost:3000/
You should now see the application welcome page.
-8. Use the default administrator account to log in:
+9. Use the default administrator account to log in:
login: admin
password: admin
diff --git a/doc/RUNNING_TESTS b/doc/RUNNING_TESTS
index 3386e6f31..40448a949 100644
--- a/doc/RUNNING_TESTS
+++ b/doc/RUNNING_TESTS
@@ -1,8 +1,9 @@
Installing gems for testing
===========================
-Run `rake gems RAILS_ENV=test` to list the required gems. Run
-`rake gems:install RAILS_ENV=test` to install any missing gems.
+Remove your .bundle/config if you've already installed Redmine without
+the test dependencies.
+Then, run `bundle install`.
Running Tests
=============
diff --git a/doc/UPGRADING b/doc/UPGRADING
index e1dafa879..ceaf55749 100644
--- a/doc/UPGRADING
+++ b/doc/UPGRADING
@@ -1,7 +1,7 @@
== Redmine upgrade
Redmine - project management software
-Copyright (C) 2006-2011 Jean-Philippe Lang
+Copyright (C) 2006-2012 Jean-Philippe Lang
http://www.redmine.org/
@@ -20,7 +20,14 @@ http://www.redmine.org/
4. Copy the folders of the installed plugins and themes into new installation
-5. Generate a session store secret
+5. Install the required gems by running:
+ 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
+
+6. Generate a session store secret
Redmine stores session data in cookies by default, which requires
a secret to be generated. Under the new application directory run:
@@ -28,7 +35,7 @@ http://www.redmine.org/
DO NOT REPLACE OR EDIT ANY OTHER FILES.
-6. Migrate your database
+7. Migrate your database
If you are upgrading to Rails 2.3.14 as part of this migration, you
need to upgrade the plugin migrations before running the plugin migrations
@@ -43,20 +50,14 @@ http://www.redmine.org/
migrations using:
rake db:migrate_plugins RAILS_ENV="production"
-7. Clean up
-
- Clear the cache and the existing sessions by running:
+8. Clear the cache and the existing sessions by running:
rake tmp:cache:clear
rake tmp:sessions:clear
-8. Restart the application server (e.g. mongrel, thin, passenger)
-
-9. Finally go to "Administration -> Roles & permissions" to check/set permissions
- for new features, if any
-
-== Notes
+9. Restart the application server (e.g. mongrel, thin, passenger)
-* Rails 2.3.14 is required for versions 1.3.x.
+10. Finally go to "Administration -> Roles & permissions" to check/set permissions
+ for new features, if any
== References