jro_apps/redmine Files · doc/INSTALL

Add static docs to YARD....

Add static docs to YARD. git-svn-id: svn+ssh://rubyforge.org/var/svn/redmine/trunk@3922 e93f8b46-1217-0410-a6f0-8f06a7374b81

Eric Davis - - Load All Authors

File last commit:

r3734:6807d070da90


                r3808:2e14ba95a034

Download file

             INSTALL
        
                    95 lines
            
             | 2.9 KiB
            
                | text/plain
            
             |
                TextLexer

/ doc / INSTALL

History | Source | Raw |Copy content |Copy permalink

Jean-Philippe Lang Slight changes for 0.6.0 release....	r870	== Redmine installation

		Redmine - project management software
Jean-Philippe Lang Updated doc....	r3179	Copyright (C) 2006-2010 Jean-Philippe Lang
Jean-Philippe Lang Slight changes for 0.6.0 release....	r870	http://www.redmine.org/


		== Requirements

Jean-Philippe Lang Adds requirement for ruby version and tells that Rails is included in downloadable releases (#4836)....	r3309	* Ruby 1.8.6 or 1.8.7

		* Ruby on Rails 2.3.5 (official downloadable Redmine releases are packaged with
		the appropriate Rails version)
Eric Davis Updated the INSTALL and UPGRADING documents for the 1.0 release....	r3734
		* Rack 1.0.1

		* RubyGems 1.3.1

		* Rake 0.8.3

Jean-Philippe Lang Updated INSTALL doc....	r1610	* A database:
		* MySQL (tested with MySQL 5)
		* PostgreSQL (tested with PostgreSQL 8.1)
		* SQLite (tested with SQLite 3)
Jean-Philippe Lang Slight changes for 0.6.0 release....	r870
		Optional:
Eric Davis Updated the INSTALL and UPGRADING documents for the 1.0 release....	r3734	* 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)
Jean-Philippe Lang Slight changes for 0.6.0 release....	r870
		== Installation

		1. Uncompress the program archive
Eric Davis Updated the INSTALL and UPGRADING documents for the 1.0 release....	r3734
Jean-Philippe Lang Slight changes for 0.6.0 release....	r870	2. Create an empty database: "redmine" for example

Eric Davis Updated the INSTALL and UPGRADING documents for the 1.0 release....	r3734	3. Configure the database parameters in config/database.yml
		for the "production" environment (default database is MySQL)
Jean-Philippe Lang Slight changes for 0.6.0 release....	r870
Jean-Philippe Lang Fixes INSTALL and UPGRADING steps order (#4848)....	r3341	4. Generate a session store secret
Eric Davis Updated the INSTALL and UPGRADING documents for the 1.0 release....	r3734
Jean-Philippe Lang Adds rake config/initializers/session_store.rb to the install doc....	r2433	Redmine stores session data in cookies by default, which requires
Eric Davis Updated the INSTALL and UPGRADING documents for the 1.0 release....	r3734	a secret to be generated. Under the application main directory run:
		rake generate_session_store

		5. Create the database structure
Jean-Philippe Lang Fixes INSTALL and UPGRADING steps order (#4848)....	r3341
Eric Davis Updated the INSTALL and UPGRADING documents for the 1.0 release....	r3734	Under the application main directory run:
		rake db:migrate RAILS_ENV="production"
Jean-Philippe Lang Fixes INSTALL and UPGRADING steps order (#4848)....	r3341
Eric Davis Updated the INSTALL and UPGRADING documents for the 1.0 release....	r3734	It will create all the tables and an administrator account.
Jean-Philippe Lang Doc update for 0.7.2 release....	r1532
Eric Davis Updated the INSTALL and UPGRADING documents for the 1.0 release....	r3734	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
Jean-Philippe Lang Doc update for 0.7.2 release....	r1532
Eric Davis Updated the INSTALL and UPGRADING documents for the 1.0 release....	r3734	7. Test the installation by running the WEBrick web server

		Under the main application directory run:
		ruby script/server -e production

Jean-Philippe Lang Slight changes for 0.6.0 release....	r870	Once WEBrick has started, point your browser to http://localhost:3000/
Eric Davis Updated the INSTALL and UPGRADING documents for the 1.0 release....	r3734	You should now see the application welcome page.
Jean-Philippe Lang Slight changes for 0.6.0 release....	r870
Eric Davis Updated the INSTALL and UPGRADING documents for the 1.0 release....	r3734	8. Use the default administrator account to log in:
Jean-Philippe Lang Slight changes for 0.6.0 release....	r870	login: admin
		password: admin

Eric Davis Updated the INSTALL and UPGRADING documents for the 1.0 release....	r3734	Go to "Administration" to load the default configuration data (roles,
		trackers, statuses, workflow) and to adjust the application settings
Jean-Philippe Lang Slight changes for 0.6.0 release....	r870
Eric Davis Updated the INSTALL and UPGRADING documents for the 1.0 release....	r3734	== SMTP server Configuration
Jean-Philippe Lang Slight changes for 0.6.0 release....	r870
Jean-Philippe Lang Email delivery configuration moved to an unversioned YAML file (config/email.yml, see the sample file) (#1412)....	r1611	Copy config/email.yml.example to config/email.yml and edit this file
		to adjust your SMTP settings.
Eric Davis Updated the INSTALL and UPGRADING documents for the 1.0 release....	r3734	Do not forget to restart the application after any change to this file.
Jean-Philippe Lang Email delivery configuration moved to an unversioned YAML file (config/email.yml, see the sample file) (#1412)....	r1611
		Please do not enter your SMTP settings in environment.rb.
Eric Davis Updated the INSTALL and UPGRADING documents for the 1.0 release....	r3734
		== 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

	Site-wide shortcuts
/	Use quick search box
g h	Goto home page
g g	Goto my private gists page
g G	Goto my public gists page
g 0-9	Goto bookmarked items from 0-9
n r	New repository page
n g	New gist page

	Repositories
g s	Goto summary page
g c	Goto changelog page
g f	Goto files page
g F	Goto files page with file search activated
g p	Goto pull requests page
g o	Goto repository settings
g O	Goto repository access permissions settings
t s	Toggle sidebar on some pages