docs/admin/Advanced-Installations.md

   1 # Advanced installations
   2
   3 This page contains instructions for setting up multiple countries in
   4 your Nominatim database. It is assumed that you have already successfully
   5 installed the Nominatim software itself, if not return to the
   6 [installation page](Installation.md).
   7
   8 ## Importing multiple regions
   9
  10 To import multiple regions in your database, you need to configure and run `utils/import_multiple_regions.sh` file. This script will set up the update directory which has the following structure:
  11
  12 ```bash
  13 update
  14     ├── europe
  15     │   ├── andorra
  16     │   │   └── sequence.state
  17     │   └── monaco
  18     │       └── sequence.state
  19     └── tmp
  20         ├── combined.osm.pbf
  21         └── europe
  22                 ├── andorra-latest.osm.pbf
  23                 └── monaco-latest.osm.pbf
  24
  25
  26 ```
  27
  28 The `sequence.state` files will contain the sequence ID, which will be used by pyosmium to get updates. The tmp folder is used for import dump.
  29
  30 ### Configuring multiple regions
  31
  32 The file `import_multiple_regions.sh` needs to be edited as per your requirement:
  33
  34 1. List of countries. eg:
  35
  36         COUNTRIES="europe/monaco europe/andorra"
  37
  38 2. Path to Build directory. eg:
  39
  40         NOMINATIMBUILD="/srv/nominatim/build"
  41
  42 3. Path to Update directory. eg:
  43
  44         UPDATEDIR="/srv/nominatim/update"
  45
  46 4. Replication URL. eg:
  47
  48         BASEURL="https://download.geofabrik.de"
  49         DOWNCOUNTRYPOSTFIX="-latest.osm.pbf"
  50
  51 !!! tip
  52     If your database already exists and you want to add more countries, replace the setting up part
  53     `${SETUPFILE} --osm-file ${UPDATEDIR}/tmp/combined.osm.pbf --all 2>&1`
  54     with `${UPDATEFILE} --import-file ${UPDATEDIR}/tmp/combined.osm.pbf 2>&1`.
  55
  56 ### Setting up multiple regions
  57
  58 Run the following command from your Nominatim directory after configuring the file.
  59
  60     bash ./utils/import_multiple_regions.sh
  61
  62 !!! danger "Important"
  63         This file uses osmium-tool. It must be installed before executing the import script.
  64         Installation instructions can be found [here](https://osmcode.org/osmium-tool/manual.html#installation).
  65
  66 ### Updating multiple regions
  67
  68 To import multiple regions in your database, you need to configure and run ```utils/update_database.sh```.
  69 This uses the update directory set up while setting up the DB.
  70
  71 ### Configuring multiple regions
  72
  73 The file `update_database.sh` needs to be edited as per your requirement:
  74
  75 1. List of countries. eg:
  76
  77         COUNTRIES="europe/monaco europe/andorra"
  78
  79 2. Path to Build directory. eg:
  80
  81         NOMINATIMBUILD="/srv/nominatim/build"
  82
  83 3. Path to Update directory. eg:
  84
  85         UPDATEDIR="/srv/nominatim/update"
  86
  87 4. Replication URL. eg:
  88
  89         BASEURL="https://download.geofabrik.de"
  90         DOWNCOUNTRYPOSTFIX="-updates"
  91
  92 5. Followup can be set according to your installation. eg: For Photon,
  93
  94         FOLLOWUP="curl http://localhost:2322/nominatim-update"
  95
  96     will handle the indexing.
  97
  98 ### Updating the database
  99
 100 Run the following command from your Nominatim directory after configuring the file.
 101
 102     bash ./utils/update_database.sh
 103
 104 This will get diffs from the replication server, import diffs and index the database. The default replication server in the script([Geofabrik](https://download.geofabrik.de)) provides daily updates.
 105
 106 ## Importing Nominatim to an external PostgreSQL database
 107
 108 You can install Nominatim using a database that runs on a different server when
 109 you have physical access to the file system on the other server. Nominatim
 110 uses a custom normalization library that needs to be made accessible to the
 111 PostgreSQL server. This section explains how to set up the normalization
 112 library.
 113
 114 ### Option 1: Compiling the library on the database server
 115
 116 The most sure way to get a working library is to compile it on the database
 117 server. From the prerequisites you need at least cmake, gcc and the
 118 PostgreSQL server package.
 119
 120 Clone or unpack the Nominatim source code, enter the source directory and
 121 create and enter a build directory.
 122
 123 ```sh
 124 cd Nominatim
 125 mkdir build
 126 cd build
 127 ```
 128
 129 Now configure cmake to only build the PostgreSQL module and build it:
 130
 131 ```
 132 cmake -DBUILD_IMPORTER=off -DBUILD_API=off -DBUILD_TESTS=off -DBUILD_DOCS=off -DBUILD_OSM2PGSQL=off ..
 133 make
 134 ```
 135
 136 When done, you find the normalization library in `build/module/nominatim.so`.
 137 Copy it to a place where it is readable and executable by the PostgreSQL server
 138 process.
 139
 140 ### Option 2: Compiling the library on the import machine
 141
 142 You can also compile the normalization library on the machine from where you
 143 run the import.
 144
 145 !!! important
 146     You can only do this when the database server and the import machine have
 147     the same architecture and run the same version of Linux. Otherwise there is
 148     no guarantee that the compiled library is compatible with the PostgreSQL
 149     server running on the database server.
 150
 151 Make sure that the PostgreSQL server package is installed on the machine
 152 **with the same version as on the database server**. You do not need to install
 153 the PostgreSQL server itself.
 154
 155 Download and compile Nominatim as per standard instructions. Once done, you find
 156 the nomrmalization library in `build/module/nominatim.so`. Copy the file to
 157 the database server at a location where it is readable and executable by the
 158 PostgreSQL server process.
 159
 160 ### Running the import
 161
 162 On the client side you now need to configure the import to point to the
 163 correct location of the library **on the database server**. Add the following
 164 line to your your `settings/local.php` file:
 165
 166 ```php
 167 @define('CONST_Database_Module_Path', '<directory on the database server where nominatim.so resides>');
 168 ```
 169
 170 Now change the `CONST_Database_DSN` to point to your remote server and continue
 171 to follow the [standard instructions for importing](/admin/Import).