From: Tom Hughes <tom@compton.nu>
Date: Sun, 20 Oct 2019 18:13:30 +0000 (+0100)
Subject: Merge remote-tracking branch 'upstream/pull/2383'
X-Git-Tag: live~3456
X-Git-Url: https://git.openstreetmap.org./rails.git/commitdiff_plain/9508368d37fe6e9d54a2d51ed8d886261ec4a9e9?ds=sidebyside;hp=-c

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

9508368d37fe6e9d54a2d51ed8d886261ec4a9e9
diff --combined INSTALL.md
index cdf3bc556,cc191aebe..4c2c7c6c8
--- a/INSTALL.md
+++ b/INSTALL.md
@@@ -31,8 -31,8 +31,8 @@@ sudo apt-get updat
  sudo apt-get install ruby2.5 libruby2.5 ruby2.5-dev bundler \
                       libmagickwand-dev libxml2-dev libxslt1-dev nodejs \
                       apache2 apache2-dev build-essential git-core phantomjs \
-                      postgresql postgresql-contrib libpq-dev postgresql-server-dev-all \
-                      libsasl2-dev imagemagick libffi-dev libgd-dev libarchive-dev libbz2-dev
+                      postgresql postgresql-contrib libpq-dev libsasl2-dev \
+                      imagemagick libffi-dev libgd-dev libarchive-dev libbz2-dev
  sudo gem2.5 install bundler
  ```
  
@@@ -46,7 -46,7 +46,7 @@@ For Fedora, you can install the minimu
  sudo dnf install ruby ruby-devel rubygem-rdoc rubygem-bundler rubygems \
                   libxml2-devel js \
                   gcc gcc-c++ git \
-                  postgresql postgresql-server postgresql-contrib postgresql-devel \
+                  postgresql postgresql-server postgresql-contrib \
                   perl-podlators ImageMagick libffi-devel gd-devel libarchive-devel \
                   bzip2-devel nodejs-yarn
  ```
@@@ -124,14 -124,6 +124,14 @@@ We use [Yarn](https://yarnpkg.com/) to 
  bundle exec rake yarn:install
  ```
  
 +## Prepare local settings file
 +
 +This is a workaround. [See issues/2185 for details](https://github.com/openstreetmap/openstreetmap-website/issues/2185#issuecomment-508676026).
 +
 +```
 +touch config/settings.local.yml
 +```
 +
  ## Storage setup
  
  The Rails port needs to be configured with an object storage facility - for
@@@ -182,20 -174,10 +182,10 @@@ psql -d openstreetmap -c "CREATE EXTENS
  
  ### PostgreSQL Functions
  
- We need to install special functions into the PostgreSQL databases, and these are provided by a library that needs compiling first.
+ We need to install some special functions into the PostgreSQL database:
  
  ```
- cd db/functions
- make libpgosm.so
- cd ../..
- ```
- 
- Then we create the functions within each database. We're using `pwd` to substitute in the current working directory, since PostgreSQL needs the full path.
- 
- ```
- psql -d openstreetmap -c "CREATE FUNCTION maptile_for_point(int8, int8, int4) RETURNS int4 AS '`pwd`/db/functions/libpgosm', 'maptile_for_point' LANGUAGE C STRICT"
- psql -d openstreetmap -c "CREATE FUNCTION tile_for_point(int4, int4) RETURNS int8 AS '`pwd`/db/functions/libpgosm', 'tile_for_point' LANGUAGE C STRICT"
- psql -d openstreetmap -c "CREATE FUNCTION xid_to_int4(xid) RETURNS int4 AS '`pwd`/db/functions/libpgosm', 'xid_to_int4' LANGUAGE C STRICT"
+ psql -d openstreetmap -f db/functions/functions.sql
  ```
  
  ### Database structure
@@@ -233,3 -215,44 +223,44 @@@ Note that the OSM map tiles you see are
  # Configuration
  
  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 (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.
+ 
+ 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:
+ 
+ ```
+ sudo apt-get install postgresql-server-dev-all
+ ```
+ 
+ On Fedora:
+ 
+ ```
+ sudo dnf install postgresql-devel
+ ```
+ 
+ The library then needs compiling.
+ 
+ ```
+ cd db/functions
+ make libpgosm.so
+ cd ../..
+ ```
+ 
+ If you previously installed the SQL versions of these functions, we'll need to delete those before adding the new ones:
+ 
+ ```
+ psql -d openstreetmap -c "DROP FUNCTION IF EXISTS maptile_for_point"
+ psql -d openstreetmap -c "DROP FUNCTION IF EXISTS tile_for_point"
+ ```
+ 
+ Then we create the functions within each database. We're using `pwd` to substitute in the current working directory, since PostgreSQL needs the full path.
+ 
+ ```
+ psql -d openstreetmap -c "CREATE FUNCTION maptile_for_point(int8, int8, int4) RETURNS int4 AS '`pwd`/db/functions/libpgosm', 'maptile_for_point' LANGUAGE C STRICT"
+ psql -d openstreetmap -c "CREATE FUNCTION tile_for_point(int4, int4) RETURNS int8 AS '`pwd`/db/functions/libpgosm', 'tile_for_point' LANGUAGE C STRICT"
+ psql -d openstreetmap -c "CREATE FUNCTION xid_to_int4(xid) RETURNS int4 AS '`pwd`/db/functions/libpgosm', 'xid_to_int4' LANGUAGE C STRICT"
+ ```