X-Git-Url: https://git.openstreetmap.org/rails.git/blobdiff_plain/ced8ac86abac9c9efad7b74a0efe2e252ddc59af..15865b5a8dcd48514b3eb00019502c28b0648caf:/INSTALL.md diff --git a/INSTALL.md b/INSTALL.md index 641d1160a..4c2c7c6c8 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -124,6 +124,14 @@ We use [Yarn](https://yarnpkg.com/) to manage the Node.js modules required for t 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 @@ -174,9 +182,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 +224,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: