Merge remote-tracking branch 'upstream/pull/3149'

[rails.git] / CONFIGURE.md

diff --git a/CONFIGURE.md b/CONFIGURE.md
index 598ea3f65d9207c25a3d7f6380c9b5319c9f2da3..c165c6d46e7478f5c25df1bd5a14f865c29b4a1f 100644 (file)
--- a/CONFIGURE.md
+++ b/CONFIGURE.md
@@ -8,7 +8,7 @@ Many settings are available in `config/settings.yml`. You can customize your ins
 
 ## Populating the database
 
 
 ## 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.
 
 
 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.
 


@@ -28,7 +28,7 @@ If you create a user by signing up to your local website, you need to confirm th
 
 ```
 $ bundle exec rails console
 
 ```
 $ 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"
 => #[ ... ]
 >> user.status = "active"
 => "active"


@@ -43,7 +43,7 @@ To give administrator or moderator permissions:
 
 ```
 $ bundle exec rails console
 
 ```
 $ 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)
 => #[ ... ]
 => #[ ... ]
 >> user.roles.create(:role => "administrator", :granter_id => user.id)
 => #[ ... ]


@@ -58,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:
 
 
 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)
 
 * 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
 
 Do the following:
 * Log into your Rails Port instance - e.g. http://localhost:3000


@@ -70,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'.
 * 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/settings.local.yml in your rails tree
 * 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/settings.local.yml in your rails tree

-* Add the "potlatch2_key" configuration key and the consumer key as the value
+* Add the "id_key" configuration key and the consumer key as the value

 * Restart your rails server
 
 An example excerpt from settings.local.yml:
 
 ```
 # Default editor
 * Restart your rails server
 
 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
 
 
 ## Troubleshooting