docs/admin/Import-and-Update.md

   1 The following instructions explain how to create a Nominatim database
   2 from an OSM planet file and how to keep the database up to date. It
   3 is assumed that you have already successfully installed the Nominatim
   4 software itself, if not return to the [installation page](Installation.md).
   5
   6 # Configuration setup in settings/local.php
   7
   8 The Nominatim server can be customized via the file `settings/local.php`
   9 in the build directory. Note that this is a PHP file, so it must always
  10 start like this:
  11
  12     <?php
  13
  14 without any leading spaces.
  15
  16 There are lots of configuration settings you can tweak. Have a look
  17 at `settings/default.php` for a full list. Most should have a sensible default.
  18
  19 ### Flatnode files
  20
  21 If you plan to import a large dataset (e.g. Europe, North America, planet),
  22 you should also enable flatnode storage of node locations. With this
  23 setting enabled, node coordinates are stored in a simple file instead
  24 of the database. This will save you import time and disk storage.
  25 Add to your `settings/local.php`:
  26
  27     @define('CONST_Osm2pgsql_Flatnode_File', '/path/to/flatnode.file');
  28
  29 Replace the second part with a suitable path on your system and make sure
  30 the directory exists. There should be at least 40GB of free space.
  31
  32 # Downloading additional data
  33
  34 ## Wikipedia rankings
  35
  36 Wikipedia can be used as an optional auxiliary data source to help indicate
  37 the importance of osm features. Nominatim will work without this information
  38 but it will improve the quality of the results if this is installed.
  39 This data is available as a binary download:
  40
  41     cd $NOMINATIM_SOURCE_DIR/data
  42     wget https://www.nominatim.org/data/wikipedia_article.sql.bin
  43     wget https://www.nominatim.org/data/wikipedia_redirect.sql.bin
  44
  45 Combined the 2 files are around 1.5GB and add around 30GB to the install
  46 size of nominatim. They also increase the install time by an hour or so.
  47
  48 *NOTE:* you'll need to download the Wikipedia rankings before performing
  49 the initial import of the data if you want the rankings applied to the
  50 loaded data.
  51
  52 ## UK postcodes
  53
  54 Nominatim can use postcodes from an external source to improve searches that involve a UK postcode. This data can be optionally downloaded:
  55
  56     cd $NOMINATIM_SOURCE_DIR/data
  57     wget https://www.nominatim.org/data/gb_postcode_data.sql.gz
  58
  59
  60 # Initial import of the data
  61
  62 **Important:** first try the import with a small excerpt, for example from
  63 [Geofabrik](https://download.geofabrik.de).
  64
  65 Download the data to import and load the data with the following command:
  66
  67 ```sh
  68 ./utils/setup.php --osm-file <data file> --all [--osm2pgsql-cache 28000] 2>&1 | tee setup.log
  69 ```
  70
  71 The `--osm2pgsql-cache` parameter is optional but strongly recommended for
  72 planet imports. It sets the node cache size for the osm2pgsql import part
  73 (see `-C` parameter in osm2pgsql help). As a rule of thumb, this should be
  74 about the same size as the file you are importing but never more than
  75 2/3 of RAM available. If your machine starts swapping reduce the size.
  76
  77 Computing word frequency for search terms can improve the performance of
  78 forward geocoding in particular under high load as it helps Postgres' query
  79 planner to make the right decisions. To recompute word counts run:
  80
  81 ```sh
  82 ./utils/update.php --recompute-word-counts
  83 ```
  84
  85 This will take a couple of hours for a full planet installation. You can
  86 also defer that step to a later point in time when you realise that
  87 performance becomes an issue. Just make sure that updates are stopped before
  88 running this function.
  89
  90 If you want to be able to search for places by their type through
  91 [special key phrases](https://wiki.openstreetmap.org/wiki/Nominatim/Special_Phrases)
  92 you also need to enable these key phrases like this:
  93
  94     ./utils/specialphrases.php --wiki-import > specialphrases.sql
  95     psql -d nominatim -f specialphrases.sql
  96
  97 Note that this command downloads the phrases from the wiki link above.
  98
  99
 100 # Installing Tiger housenumber data for the US
 101
 102 Nominatim is able to use the official TIGER address set to complement the
 103 OSM house number data in the US. You can add TIGER data to your own Nominatim
 104 instance by following these steps:
 105
 106   1. Install the GDAL library and python bindings and the unzip tool
 107
 108        * Ubuntu: `sudo apt-get install python-gdal unzip`
 109        * CentOS: `sudo yum install gdal-python unzip`
 110
 111   2. Get preprocessed TIGER 2015 data and unpack it into the
 112      data directory in your Nominatim sources:
 113
 114         cd Nominatim/data
 115         wget https://nominatim.org/data/tiger2017-nominatim-preprocessed.tar.gz
 116         tar xf tiger2017-nominatim-preprocessed.tar.gz
 117
 118   3. Import the data into your Nominatim database:
 119
 120         ./utils/setup.php --import-tiger-data
 121
 122   4. Enable use of the Tiger data in your `settings/local.php` by adding:
 123
 124          @define('CONST_Use_US_Tiger_Data', true);
 125
 126   5. Apply the new settings:
 127
 128 ```sh
 129     ./utils/setup.php --create-functions --enable-diff-updates --create-partition-functions
 130 ```
 131
 132 The entire US adds about 10GB to your database.
 133
 134 You can also process the data from the original TIGER data to create the
 135 SQL files, Nominatim needs for the import:
 136
 137   1. Get the TIGER 2017 data. You will need the EDGES files
 138      (3,234 zip files, 11GB total). Choose one of the two sources:
 139
 140          wget -r ftp://ftp2.census.gov/geo/tiger/TIGER2017/EDGES/
 141          wget -r ftp://mirror1.shellbot.com/census/geo/tiger/TIGER2017/EDGES/
 142
 143      The first one is the original source, the second a considerably faster
 144      mirror.
 145
 146   2. Convert the data into SQL statements:
 147
 148          ./utils/imports.php --parse-tiger <tiger edge data directory>
 149
 150 Be warned that this can take quite a long time. After this process is finished,
 151 the same preprocessed files as above are available in `data/tiger`.
 152
 153 # Updates
 154
 155 There are many different possibilities to update your Nominatim database.
 156 The following section describes how to keep it up-to-date with Pyosmium.
 157 For a list of other methods see the output of `./utils/update.php --help`.
 158
 159 ### Installing the newest version of Pyosmium
 160
 161 It is recommended to install Pyosmium via pip. Run (as the same user who
 162 will later run the updates):
 163
 164 ```sh
 165 pip install --user osmium
 166 ```
 167
 168 Nominatim needs a tool called `pyosmium-get-updates` that comes with
 169 Pyosmium. You need to tell Nominatim where to find it. Add the
 170 following line to your `settings/local.php`:
 171
 172     @define('CONST_Pyosmium_Binary', '/home/user/.local/bin/pyosmium-get-changes');
 173
 174 The path above is fine if you used the `--user` parameter with pip.
 175 Replace `user` with your user name.
 176
 177 ### Setting up the update process
 178
 179 Next the update needs to be initialised. By default Nominatim is configured
 180 to update using the global minutely diffs.
 181
 182 If you want a different update source you will need to add some settings
 183 to `settings/local.php`. For example, to use the daily country extracts
 184 diffs for Ireland from geofabrik add the following:
 185
 186     // base URL of the replication service
 187     @define('CONST_Replication_Url', 'https://download.geofabrik.de/europe/ireland-and-northern-ireland-updates');
 188     // How often upstream publishes diffs
 189     @define('CONST_Replication_Update_Interval', '86400');
 190     // How long to sleep if no update found yet
 191     @define('CONST_Replication_Recheck_Interval', '900');
 192
 193 To set up the update process now run the following command:
 194
 195     ./utils/update.php --init-updates
 196
 197 It outputs the date where updates will start. Recheck that this date is
 198 what you expect.
 199
 200 The --init-updates command needs to be rerun whenever the replication service
 201 is changed.
 202
 203 ### Updating Nominatim
 204
 205 The following command will keep your database constantly up to date:
 206
 207     ./utils/update.php --import-osmosis-all
 208
 209 (Note that even though the old name "import-osmosis-all" has been kept for compatibility reasons, Osmosis is not required to run this - it uses pyosmium behind the scenes.)
 210
 211 If you have imported multiple country extracts and want to keep them
 212 up-to-date, have a look at the script in
 213 [issue #60](https://github.com/openstreetmap/Nominatim/issues/60).
 214