diff options
| author | Jean-Philippe Lang <jp_lang@yahoo.fr> | 2006-12-05 20:45:04 +0000 |
|---|---|---|
| committer | Jean-Philippe Lang <jp_lang@yahoo.fr> | 2006-12-05 20:45:04 +0000 |
| commit | 96f83cc8f0f032554f771a59da22303cd473b878 (patch) | |
| tree | 355a0d2ed653a5426c59ebf6a1fe65eba024b4d0 /doc/INSTALL | |
| parent | eabc04d8368824965d3ac8de3fa84502e9c05d38 (diff) | |
| download | redmine-96f83cc8f0f032554f771a59da22303cd473b878.tar.gz redmine-96f83cc8f0f032554f771a59da22303cd473b878.zip | |
trunk moved from /trunk/redmine to /trunk
git-svn-id: http://redmine.rubyforge.org/svn/trunk@67 e93f8b46-1217-0410-a6f0-8f06a7374b81
Diffstat (limited to 'doc/INSTALL')
| -rw-r--r-- | doc/INSTALL | 74 |
1 files changed, 74 insertions, 0 deletions
diff --git a/doc/INSTALL b/doc/INSTALL new file mode 100644 index 000000000..9e29b6ddc --- /dev/null +++ b/doc/INSTALL @@ -0,0 +1,74 @@ +== redMine installation
+
+redMine - project management software
+Copyright (C) 2006 Jean-Philippe Lang
+http://redmine.org/
+
+
+== Requirements
+
+* Ruby on Rails 1.1
+* Iconv
+* a database (see compatibility below)
+* (recommended) Apache/Lighttpd with FCGI support
+
+Optional:
+* RedCloth (for textile formatting)
+* Net::LDAP for Ruby (for LDAP authentication)
+
+Supported databases:
+* MySQL (tested with MySQL 5)
+* PostgreSQL (tested with PostgreSQL 8.1)
+* Oracle (tested with Oracle 10g)
+* SQL Server (tested with SQL Server 2005)
+* SQLite (tested with SQLite 3)
+
+
+== Upgrade
+
+Due to major database changes, there is no migration support from beta 0.2.0.
+Next releases (0.3.0+) will be provided with upgrade support.
+
+
+== Installation
+
+1. Uncompress program archive:
+ tar zxvf <filename>
+
+2. Create an empty database: "redmine" for example
+
+3. Configure database parameters in config/database.yml
+ for "production" environment (default database is MySQL)
+
+4. Create the database structure. Under application main directory:
+ rake migrate RAILS_ENV="production"
+ It will create tables and default configuration data
+
+5. Insert default configuration data in database:
+ rake load_default_data RAILS_ENV="production"
+ This step is optional, as you can define your own configuration
+ (roles, trackers, statuses, workflows, enumerations) from sratch
+
+6. Test the installation by running WEBrick web server:
+ ruby script/server -e production
+
+ Once WEBrick has started, point your browser to http://localhost:3000/
+ You should now see the application welcome page
+
+7. Use default administrator account to log in:
+ login: admin
+ password: admin
+
+8. Setup Apache or Lighttpd with fastcgi for best performance.
+
+
+== Configuration
+
+A sample configuration file is provided: "config/config_custom.example.rb"
+Rename it to config_custom.rb and edit parameters.
+Don't forget to restart the application after any change.
+
+
+config.action_mailer.server_settings: SMTP server configuration
+config.action_mailer.perform_deliveries: set to false to disable mail delivering
+
|