From e1cacdbe0e1ec7b4503613d808a884060857a2f4 Mon Sep 17 00:00:00 2001 From: Andy Allan Date: Wed, 13 Mar 2019 17:54:41 +0100 Subject: [PATCH] Update documentation for new approach to settings --- CONFIGURE.md | 12 +++++++----- INSTALL.md | 10 ---------- 2 files changed, 7 insertions(+), 15 deletions(-) diff --git a/CONFIGURE.md b/CONFIGURE.md index c6444ffa9..91a64119e 100644 --- a/CONFIGURE.md +++ b/CONFIGURE.md @@ -2,6 +2,10 @@ 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. @@ -71,11 +75,11 @@ Do the following: * 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 "potlatch2_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 @@ -86,8 +90,6 @@ potlatch2_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. -**NOTE:** If you forget to set up OAuth, then you will get an error message similar to `uninitialized constant ActionView::CompiledTemplates::ID_KEY`. - ## Troubleshooting Rails has its own log. To inspect the log, do this: diff --git a/INSTALL.md b/INSTALL.md index 8e47cb266..f069521eb 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -115,16 +115,6 @@ cd openstreetmap-website bundle install ``` -## Application setup - -We need to create the `config/application.yml` file from the example template. This contains various configuration options. - -``` -cp config/example.application.yml config/application.yml -``` - -You can customize your installation of The Rails Port by changing the values in `config/application.yml` - ## Database setup The Rails Port uses three databases - one for development, one for testing, and one for production. The database-specific configuration -- 2.39.5