diff options
| author | Marc Florisson | 2014-02-17 10:00:32 +0100 | 
|---|---|---|
| committer | Marc Florisson | 2014-02-17 10:00:32 +0100 | 
| commit | ab48df59b9510080beef8db58985ba056eac7792 (patch) | |
| tree | e7628e1e95eed432ef3c5c1a4e9f8b235019c9d4 /README.md | |
| parent | a2b88b6612435a4a2883c4a378115068df941e5b (diff) | |
| download | chouette-core-ab48df59b9510080beef8db58985ba056eac7792.tar.bz2 | |
add more configuration instructions
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 43 | 
1 files changed, 23 insertions, 20 deletions
| @@ -10,7 +10,7 @@ Chouette2 is an open source web project in Ruby/Rails to edit and view transport  It uses java library from another git project to import and export various transport data [chouette](http://github.com/afimb/chouette) -Feel free to test and access to the demonstration web site at [http://www.chouette.mobi](http://www.chouette.mobi/chouette2/users/sign_in). Two types of access are granted :  +Feel free to test and access to the demonstration web site at [http://www.chouette.mobi](http://www.chouette.mobi/chouette2/users/sign_in). Two types of access are granted :  * A demo organisation with a set of data    * login : demo@chouette.mobi    * password : chouette @@ -18,8 +18,8 @@ Feel free to test and access to the demonstration web site at [http://www.chouet  Requirements  ------------ -  -This code has been run and tested on [Travis](http://travis-ci.org/afimb/chouette2?branch=master) with :  + +This code has been run and tested on [Travis](http://travis-ci.org/afimb/chouette2?branch=master) with :  * Ruby 1.9.3  * Postgres 9.x  * Proj 4.8.0 @@ -29,10 +29,10 @@ External Deps  On Debian/Ubuntu/Kubuntu OS : assume depot contains the correct version  ```sh -sudo apt-get install postgresql  -sudo apt-get install pgadmin3  -sudo apt-get install openjdk-7-jdk  -sudo apt-get install git  +sudo apt-get install postgresql +sudo apt-get install pgadmin3 +sudo apt-get install openjdk-7-jdk +sudo apt-get install git  sudo apt-get install unzip  sudo apt-get install ruby  sudo apt-get install proj-bin @@ -43,7 +43,7 @@ sudo apt-get install make  Installation  ------------ -Get git source code :  +Get git source code :  ```sh  cd workspace  git clone -b V2_2 git://github.com/afimb/chouette2 @@ -52,7 +52,7 @@ cd chouette2  The next step assume default path defined by ```Chouette::Command.command``` in file [production.rb](./config/environments/production.rb) is unchanged -Install chouette-gui-command to import, export and validate transport offer :  +Install chouette-gui-command to import, export and validate transport offer :  ```sh  sudo mkdir -p /usr/local/opt/chouette-command/  cd /usr/local/opt/chouette-command/ @@ -62,22 +62,22 @@ mv chouette-gui-command-2.2.0.zip chouette-cmd_2.2.0  cd chouette-cmd_2.2.0  sudo chmod a+w .  ``` -  +  Create [Postgres database user] (./doc/install/postgresql.md)  Download gem libraries and create database -```sh  +```sh  setenv RAILS_ENV=production  bundle install  bundle exec rake db:create  ```  The next step assume default path defined by following settings in file [production.rb](./config/environments/production.rb) are unchanged -* ```ImportTask.root```  +* ```ImportTask.root```  * ```Export.root```  Create directories -```sh  +```sh  sudo mkdir -p /var/lib/chouette/imports  sudo mkdir -p /var/lib/chouette/exports  sudo mkdir -p /var/lib/chouette/validations @@ -95,6 +95,9 @@ Configure SMTP settings.  * Edit [production.rb](./config/environments/production.rb) and change ```ActionMailer::Base.smtp_settings```  * see [Action Mailer Configuration documentation](http://guides.rubyonrails.org/action_mailer_basics.html) +Configure e-mail address shown on mail sent when user registers, re-initialises its password, ... +* Edit [production.rb](./config/environments/production.rb) and change ```config.mailer_sender``` +  Configure IGN Géoportail Key.  * Edit [production.rb](./config/environments/production.rb) and uncomment and set```config.geoportail_api_key```  * see [API Géoportail documentation](http://api.ign.fr/accueil) @@ -132,29 +135,29 @@ bundle exec rake spec  More Information  ---------------- -  -More information can be found on the [project website on GitHub](.).  + +More information can be found on the [project website on GitHub](.).  There is extensive usage documentation available [on the wiki](../../wiki).  API Documentation  ----------------- -The description of the restful API is described in :  +The description of the restful API is described in :  * [User manual file](./doc/interfaces/Chouette_API_REST_v1.2.pdf)  * [XSD file](./doc/interfaces/api_rest_v1.xsd)  License  ------- -  +  This project is licensed under the CeCILL-B license, a copy of which can be found in the [LICENSE](./LICENSE.md) file.  Release Notes  ------------- -The release notes can be found in [CHANGELOG](./CHANGELOG.md) file  -  +The release notes can be found in [CHANGELOG](./CHANGELOG.md) file +  Support  ------- -  +  Users looking for support should file an issue on the GitHub [issue tracking page](../../issues), or file a [pull request](../../pulls) if you have a fix available. | 
