Make documentation clearer and shorter by deferring complicated shared-library SQL...
authorMatt Amos <zerebubuth@gmail.com>
Wed, 9 Oct 2019 11:13:27 +0000 (12:13 +0100)
committerMatt Amos <zerebubuth@gmail.com>
Wed, 9 Oct 2019 11:13:27 +0000 (12:13 +0100)
CONFIGURE.md
INSTALL.md

index 91a6411..42f65b5 100644 (file)
@@ -131,3 +131,5 @@ If you want to deploy The Rails Port for production use, you'll need to make a f
 * 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 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 want to use diff replication then you will need to install the shared library versions of the special SQL functions (see the bottom of [INSTALL.md](INSTALL.md)).
+* 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.
index 641d116..cc191ae 100644 (file)
@@ -174,9 +174,7 @@ psql -d openstreetmap -c "CREATE EXTENSION btree_gist"
 
 ### PostgreSQL Functions
 
-There are special database functions required by a (little-used) API call, the migrations and diff replication. The former two are provided as *either* pure SQL functions or a compiled shared library. It is recommended that you start with the pure SQL versions, as described below, and only install the compiled shared library if you are running a production server making a lot of `/changes` API calls or need the diff replication functionality.
-
-If you aren't sure which you need, install the SQL version below.
+We need to install some special functions into the PostgreSQL database:
 
 ```
 psql -d openstreetmap -f db/functions/functions.sql
@@ -218,9 +216,11 @@ Note that the OSM map tiles you see aren't created from your local database - th
 
 After installing this software, you may need to carry out some [configuration steps](CONFIGURE.md), depending on your tasks.
 
-# Installing compiled shared library database functions
+# Installing compiled shared library database functions (optional)
+
+There are special database functions required by a (little-used) API call, the migrations and diff replication. The former two are provided as *either* pure SQL functions or a compiled shared library. The SQL versions are installed as part of the recommended install procedure above and the shared library versions are recommended only if you are running a production server making a lot of `/changes` API calls or need the diff replication functionality.
 
-You probably only need to do this if you are running a large, production instance of openstreetmap-website.
+If you aren't sure which you need, stick with the SQL versions.
 
 Before installing the functions, it's necessary to install the PostgreSQL server development packages. On Ubuntu this means: