config/example/database.yml db/schema.example.rb script/setup @@ -26,8 +26,8 @@ Plus the following which are *optional*: The following configuration files need to be present: -* `config/database.yml` (example at `config/database.yml.template`) -* `config/app_keys.yml` (example at `config/app_keys.yml.template`) +* `config/database.yml` (example at `config/examples/database.yml.template`) +* `config/app_keys.yml` (generated by setup script) ## Deployment @@ -42,9 +42,9 @@ An example VirtualHost for Phusion Passenger deployment would be: DocumentRoot /path/to/railscollab/public </VirtualHost> -In order to facilitate deployment, a rake task called db:railscollab:install +In order to facilitate deployment, a script located at `script/setup` has been provided, which will create an initial database. -The rake task accepts the following environment variables: +It accepts the following environment variables: RAILSCOLLAB_INITIAL_USER The username of the administrative user @@ -67,7 +67,7 @@ The rake task accepts the following environment variables: So from scratch, you'd likely do something like to following to install: 1. Create a 'railscollab' database -2. Create a config/database.yml file based on config/database.yml.template, using either the development or production environments as your basis. +2. Create a config/database.yml file based on config/example/database.yml 3. Run the snippit below 4. Insert the previously mentioned VirtualHost configuration into your Phusion Passenger installation. 5. Go to http://servername and login using your supplied credentials @@ -80,7 +80,7 @@ The snippit: RAILSCOLLAB_INITIAL_EMAIL="billg@microsoft.com" \ RAILSCOLLAB_INITIAL_COMPANY="Microsoft" \ RAILSCOLLAB_SITE_URL="projects.microsoft.com" \ - rake db:railscollab:install + script/setup For more advanced deployment (e.g. using FastCGI or load balancing proxies), refer to the Ruby on Rails documentation. INSTALL.markdown @@ -22,7 +22,13 @@ whose access can be restricted to certain elements of the project. ## How can i install / upgrade? -Refer to the [INSTALL.markdown] [3] and [UPGRADE.markdown] [4] files +Simply run the following: + + script/setup + +And login using the username `admin`, with the password `password`. + +For more advanced setup options, refer to the [INSTALL.markdown] [3] and [UPGRADE.markdown] [4] files ## I do i do [x]? README.markdown config/app_keys.example.yml config/database.yml.template db/schema.rb fb58e7af87585acb310f4798b14f170b5da3bc27 jamesu jamesu@gmail.com http://github.com/jamesu/railscollab/commit/52600c706d15efb7450ee2fe830375b460abbb3f 52600c706d15efb7450ee2fe830375b460abbb3f 2009-08-21T09:09:32-07:00 2009-08-21T09:06:16-07:00 Revamped setup. Now all you need to do at a minimum is script/setup! 2ddcddaa1923c9b21dc9a094bfde5e7da4d349a9 jamesu jamesu@gmail.com