Localisation updates from https://translatewiki.net.

[rails.git] / CONFIGURE.md

diff --git a/CONFIGURE.md b/CONFIGURE.md
index 3cbe31cb9f4ac650214f81a260714dbe3d049f8f..f7638a49a61c09c2b9ca5516eb1420cb75d37bd0 100644 (file)
--- a/CONFIGURE.md
+++ b/CONFIGURE.md
@@ -2,9 +2,13 @@
 
 After [installing](INSTALL.md) this software, you may need to carry out some of these configuration steps, depending on your tasks.
 
+## Application configuration
+
+Many settings are available in `config/settings.yml`. You can customize your installation of The Rails Port by overriding these values using `config/settings.local.yml`
+
 ## Populating the database
 
-Your installation comes with no geographic data loaded. You can either create new data using one of the editors (Potlatch 2, iD, JOSM etc) or by loading an OSM extract.
+Your installation comes with no geographic data loaded. You can either create new data using one of the editors (iD, JOSM etc) or by loading an OSM extract.
 
 After installing but before creating any users or data, import an extract with [Osmosis](https://wiki.openstreetmap.org/wiki/Osmosis) and the [``--write-apidb``](https://wiki.openstreetmap.org/wiki/Osmosis/Detailed_Usage#--write-apidb_.28--wd.29) task.
 
@@ -24,7 +28,7 @@ If you create a user by signing up to your local website, you need to confirm th
 
 ```
 $ bundle exec rails console
->> user = User.find_by_display_name("My New User Name")
+>> user = User.find_by(:display_name => "My New User Name")
 => #[ ... ]
 >> user.status = "active"
 => "active"
@@ -39,7 +43,7 @@ To give administrator or moderator permissions:
 
 ```
 $ bundle exec rails console
->> user = User.find_by_display_name("My New User Name")
+>> user = User.find_by(:display_name => "My New User Name")
 => #[ ... ]
 >> user.roles.create(:role => "administrator", :granter_id => user.id)
 => #[ ... ]
@@ -54,11 +58,10 @@ $ bundle exec rails console
 
 Three of the built-in applications communicate via the API, and therefore need OAuth consumer keys configured. These are:
 
-* Potlatch 2
 * iD
 * The website itself (for the Notes functionality)
 
-For example, to use the Potlatch 2 editor you need to register it as an OAuth application.
+For example, to use the iD editor you need to register it as an OAuth application.
 
 Do the following:
 * Log into your Rails Port instance - e.g. http://localhost:3000
@@ -66,25 +69,25 @@ Do the following:
 * Click on "my settings" on the user page
 * Click on "oauth settings" on the My settings page
 * Click on 'Register your application'.
-* Unless you have set up alternatives, use Name: "Local Potlatch" and URL: "http://localhost:3000"
+* Unless you have set up alternatives, use Name: "Local iD" and URL: "http://localhost:3000"
 * Check the 'modify the map' box.
 * Everything else can be left with the default blank values.
 * Click the "Register" button
 * On the next page, copy the "consumer key"
-* Edit config/application.yml in your rails tree
-* Uncomment and change the "potlatch2_key" configuration value
+* Edit config/settings.local.yml in your rails tree
+* Add the "id_key" configuration key and the consumer key as the value
 * Restart your rails server
 
-An example excerpt from application.yml:
+An example excerpt from settings.local.yml:
 
 ```
 # Default editor
-default_editor: "potlatch2"
-# OAuth consumer key for Potlatch 2
-potlatch2_key: "8lFmZPsagHV4l3rkAHq0hWY5vV3Ctl3oEFY1aXth"
+default_editor: "id"
+# OAuth consumer key for iD
+id_key: "8lFmZPsagHV4l3rkAHq0hWY5vV3Ctl3oEFY1aXth"
 ```
 
-Follow the same process for registering and configuring iD (`id_key`) and the website/Notes (`oauth_key`), or to save time, simply reuse the same consumer key for each.
+Follow the same process for registering and configuring the website/Notes (`oauth_key`), or to save time, simply reuse the same consumer key for each.
 
 ## Troubleshooting
 
@@ -124,6 +127,6 @@ If you want to deploy The Rails Port for production use, you'll need to make a f
 * Passenger will, by design, use the Production environment and therefore the production database - make sure it contains the appropriate data and user accounts.
 * Your production database will also need the extensions and functions installed - see [INSTALL.md](INSTALL.md)
 * The included version of the map call is quite slow and eats a lot of memory. You should consider using [CGIMap](https://github.com/zerebubuth/openstreetmap-cgimap) instead.
-* The included version of the GPX importer is slow and/or completely inoperable. You should consider using [the high-speed GPX importer](https://git.openstreetmap.org/gpx-import.git/).
-* Make sure you precompile the production assets: `RAILS_ENV=production rake assets:precompile`
+* Make sure you generate the i18n files and precompile the production assets: `RAILS_ENV=production rake i18n:js:export assets:precompile`
 * Make sure the web server user as well as the rails user can read, write and create directories in `tmp/`.
+* If you expect to serve a lot of `/changes` API calls, then you might also want to install the shared library versions of the SQL functions.