[#211] Updating rdoc documentation
This commit is contained in:
parent
d8ca508566
commit
fa64a39203
|
@ -19,3 +19,4 @@
|
||||||
/tmp/test/*
|
/tmp/test/*
|
||||||
/vendor/rails
|
/vendor/rails
|
||||||
*.rbc
|
*.rbc
|
||||||
|
doc/app
|
||||||
|
|
|
@ -6,7 +6,7 @@ More documentation and user guides can be found on the official website[https://
|
||||||
|
|
||||||
== Getting Started
|
== Getting Started
|
||||||
|
|
||||||
We have a complete {install guide}[https://www.chiliproject.org/projects/chiliproject/wiki/Installation] online. A short version of it is mirrored to doc/INSTALL for offline installations
|
We have a complete {install guide}[https://www.chiliproject.org/projects/chiliproject/wiki/Installation] online.
|
||||||
|
|
||||||
== Getting Help
|
== Getting Help
|
||||||
|
|
||||||
|
|
|
@ -1,8 +1,6 @@
|
||||||
== Redmine changelog
|
= ChiliProject changelog
|
||||||
|
|
||||||
Redmine - project management software
|
Note: Previous versions referred to Redmine, which ChiliProject forked from in December 2010.
|
||||||
Copyright (C) 2006-2011 Jean-Philippe Lang
|
|
||||||
http://www.redmine.org/
|
|
||||||
|
|
||||||
== 2011-01-30 v1.1.1
|
== 2011-01-30 v1.1.1
|
||||||
|
|
||||||
|
|
|
@ -1,97 +1,3 @@
|
||||||
== Redmine installation
|
= Install
|
||||||
|
|
||||||
Redmine - project management software
|
The detailed installation instructions are located on the {official website}[https://www.chiliproject.org/projects/chiliproject/wiki/Installation]
|
||||||
Copyright (C) 2006-2010 Jean-Philippe Lang
|
|
||||||
http://www.redmine.org/
|
|
||||||
|
|
||||||
|
|
||||||
== Requirements
|
|
||||||
|
|
||||||
* Ruby 1.8.6 or 1.8.7
|
|
||||||
|
|
||||||
* RubyGems 1.3.1
|
|
||||||
|
|
||||||
* Ruby on Rails 2.3.5 (official downloadable Redmine releases are packaged with
|
|
||||||
the appropriate Rails version)
|
|
||||||
|
|
||||||
* Rack 1.0.1 gem
|
|
||||||
|
|
||||||
* Rake 0.8.3 gem
|
|
||||||
|
|
||||||
* I18n 0.4.2 gem
|
|
||||||
|
|
||||||
* A database:
|
|
||||||
* MySQL (tested with MySQL 5)
|
|
||||||
* PostgreSQL (tested with PostgreSQL 8.1)
|
|
||||||
* SQLite (tested with SQLite 3)
|
|
||||||
|
|
||||||
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)
|
|
||||||
|
|
||||||
== Installation
|
|
||||||
|
|
||||||
1. Uncompress the program archive
|
|
||||||
|
|
||||||
2. Create an empty database: "redmine" for example
|
|
||||||
|
|
||||||
3. Configure the database parameters in config/database.yml
|
|
||||||
for the "production" environment (default database is MySQL)
|
|
||||||
|
|
||||||
4. 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
|
|
||||||
|
|
||||||
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)
|
|
||||||
|
|
||||||
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
|
|
||||||
|
|
||||||
7. Test the installation by running the WEBrick web server
|
|
||||||
|
|
||||||
Under the main application directory run:
|
|
||||||
ruby script/server -e production
|
|
||||||
|
|
||||||
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:
|
|
||||||
login: admin
|
|
||||||
password: admin
|
|
||||||
|
|
||||||
Go to "Administration" to load the default configuration data (roles,
|
|
||||||
trackers, statuses, workflow) and to adjust the application settings
|
|
||||||
|
|
||||||
== SMTP server Configuration
|
|
||||||
|
|
||||||
Copy config/configuration.yml.example to config/configuration.yml and
|
|
||||||
edit this file to adjust your SMTP settings.
|
|
||||||
Do not forget to restart the application after any change to this file.
|
|
||||||
|
|
||||||
Please do not enter your SMTP settings in environment.rb.
|
|
||||||
|
|
||||||
== 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
|
|
||||||
|
|
|
@ -1,11 +1,9 @@
|
||||||
Installing gems for testing
|
= Installing gems for testing
|
||||||
===========================
|
|
||||||
|
|
||||||
Run `rake gems RAILS_ENV=test` to list the required gems. Run
|
Run `rake gems RAILS_ENV=test` to list the required gems. Run
|
||||||
`rake gems:install RAILS_ENV=test` to install any missing gems.
|
`rake gems:install RAILS_ENV=test` to install any missing gems.
|
||||||
|
|
||||||
Running Tests
|
== Running Tests
|
||||||
=============
|
|
||||||
|
|
||||||
Run `rake --tasks test` to see available tests.
|
Run `rake --tasks test` to see available tests.
|
||||||
`rake test` will run the entire testsuite.
|
`rake test` will run the entire testsuite.
|
||||||
|
@ -13,20 +11,18 @@ Run `rake --tasks test` to see available tests.
|
||||||
Before running `rake test` you need to configure both development
|
Before running `rake test` you need to configure both development
|
||||||
and test databases.
|
and test databases.
|
||||||
|
|
||||||
Creating test repositories
|
== Creating test repositories
|
||||||
===================
|
|
||||||
|
|
||||||
Redmine supports a wide array of different version control systems.
|
ChiliProject supports a wide array of different version control systems.
|
||||||
To test the support, a test repository needs to be created for each of those.
|
To test the support, a test repository needs to be created for each of those.
|
||||||
|
|
||||||
Run `rake --tasks test:scm:setup` for a list of available test-repositories or
|
Run `rake --tasks test:scm:setup` for a list of available test-repositories or
|
||||||
run `rake test:scm:setup:all` to set up all of them
|
run `rake test:scm:setup:all` to set up all of them
|
||||||
|
|
||||||
Creating a test ldap database
|
== Creating a test ldap database
|
||||||
=============================
|
|
||||||
|
|
||||||
Redmine supports using LDAP for user authentications. To test LDAP
|
ChiliProject supports using LDAP for user authentications. To test LDAP
|
||||||
with Redmine, load the LDAP export from test/fixtures/ldap/test-ldap.ldif
|
with ChiliProject, load the LDAP export from test/fixtures/ldap/test-ldap.ldif
|
||||||
into a testing LDAP server. Test that the ldap server can be accessed
|
into a testing LDAP server. Test that the ldap server can be accessed
|
||||||
at 127.0.0.1 on port 389.
|
at 127.0.0.1 on port 389.
|
||||||
|
|
||||||
|
|
|
@ -1,63 +1,3 @@
|
||||||
== Redmine upgrade
|
= Upgrade
|
||||||
|
|
||||||
Redmine - project management software
|
The detailed upgrade instructions are located on the {official website}[https://www.chiliproject.org/projects/chiliproject/wiki/Upgrade]
|
||||||
Copyright (C) 2006-2010 Jean-Philippe Lang
|
|
||||||
http://www.redmine.org/
|
|
||||||
|
|
||||||
|
|
||||||
== Upgrading
|
|
||||||
|
|
||||||
1. Uncompress the program archive in a new directory
|
|
||||||
|
|
||||||
2. Copy your database settings (RAILS_ROOT/config/database.yml)
|
|
||||||
and your configuration file (RAILS_ROOT/config/configuration.yml)
|
|
||||||
into the new config directory
|
|
||||||
Note: before Redmine 1.2, SMTP configuration was stored in
|
|
||||||
config/email.yml. It should now be stored in config/configuration.yml.
|
|
||||||
|
|
||||||
3. Copy the RAILS_ROOT/files directory content into your new installation
|
|
||||||
This directory contains all the attached files.
|
|
||||||
|
|
||||||
4. Copy the folders of the installed plugins and themes into new installation
|
|
||||||
|
|
||||||
5. 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:
|
|
||||||
rake generate_session_store
|
|
||||||
|
|
||||||
DO NOT REPLACE OR EDIT ANY OTHER FILES.
|
|
||||||
|
|
||||||
6. Migrate your database
|
|
||||||
|
|
||||||
If you are upgrading to Rails 2.3.5 as part of this migration, you
|
|
||||||
need to upgrade the plugin migrations before running the plugin migrations
|
|
||||||
using:
|
|
||||||
rake db:migrate:upgrade_plugin_migrations RAILS_ENV="production"
|
|
||||||
|
|
||||||
Please make a backup before doing this! Under the new application
|
|
||||||
directory run:
|
|
||||||
rake db:migrate RAILS_ENV="production"
|
|
||||||
|
|
||||||
If you have installed any plugins, you should also run their database
|
|
||||||
migrations using:
|
|
||||||
rake db:migrate_plugins RAILS_ENV="production"
|
|
||||||
|
|
||||||
7. Clean up
|
|
||||||
|
|
||||||
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
|
|
||||||
|
|
||||||
* Rails 2.3.5 is required for versions 0.9.x and 1.0.x.
|
|
||||||
|
|
||||||
== References
|
|
||||||
|
|
||||||
* http://www.redmine.org/wiki/redmine/RedmineUpgrade
|
|
||||||
|
|
Loading…
Reference in New Issue