docs/Import_and_update.md

   1 Importing a new database
   2 ========================
   3
   4 The following instructions explain how to create a Nominatim database
   5 from an OSM planet file and how to keep the database up to date. It
   6 is assumed that you have already sucessfully installed the Nominatim
   7 software itself, if not return to the [installation page](Installation.md).
   8
   9 Configuration setup in settings/local.php
  10 -----------------------------------------
  11
  12 There are lots of configuration settings you can tweak. Have a look
  13 at `settings/settings.php` for a full list. Most should have a sensible default.
  14 If you plan to import a large dataset (e.g. Europe, North America, planet),
  15 you should also enable flatnode storage of node locations. With this
  16 setting enabled, node coordinates are stored in a simple file instead
  17 of the database. This will save you import time and disk storage.
  18 Add to your settings/local.php:
  19
  20     @define('CONST_Osm2pgsql_Flatnode_File', '/path/to/flatnode.file');
  21
  22
  23 Downloading additional data
  24 ---------------------------
  25
  26 ### Wikipedia rankings
  27
  28 Wikipedia can be used as an optional auxiliary data source to help indicate
  29 the importance of osm features. Nominatim will work without this information
  30 but it will improve the quality of the results if this is installed.
  31 This data is available as a binary download:
  32
  33     cd $NOMINATIM_SOURCE_DIR/data
  34     wget http://www.nominatim.org/data/wikipedia_article.sql.bin
  35     wget http://www.nominatim.org/data/wikipedia_redirect.sql.bin
  36
  37 Combined the 2 files are around 1.5GB and add around 30GB to the install
  38 size of nominatim. They also increase the install time by an hour or so.
  39
  40 ### UK postcodes
  41
  42 Nominatim can use postcodes from an external source to improve searches that involve a UK postcode. This data can be optionally downloaded:
  43
  44     cd $NOMINATIM_SOURCE_DIR/data
  45     wget http://www.nominatim.org/data/gb_postcode_data.sql.gz
  46
  47
  48 Initial import of the data
  49 --------------------------
  50
  51 **Important:** first try the import with a small excerpt, for example from
  52 [Geofabrik](http://download.geofabrik.de).
  53
  54 Download the data to import and load the data with the following command:
  55
  56     ./utils/setup.php --osm-file <your data file> --all [--osm2pgsql-cache 28000] 2>&1 | tee setup.log
  57
  58 The --osm2pgsql-cache parameter is optional but strongly recommended for
  59 planet imports. It sets the node cache size for the osm2pgsql import part
  60 (see -C parameter in osm2pgsql help). 28GB are recommended for a full planet
  61 import, for excerpts you can use less. Adapt to your available RAM to
  62 avoid swapping, never give more than 2/3 of RAM to osm2pgsql.
  63
  64
  65 Loading additional datasets
  66 ---------------------------
  67
  68 The following commands will create additional entries for countries and POI searches:
  69
  70     ./utils/specialphrases.php --countries > specialphrases_countries.sql
  71     psql -d nominatim -f specialphrases_countries.sql
  72     ./utils/specialphrases.php --wiki-import > specialphrases.sql
  73     psql -d nominatim -f specialphrases.sql
  74
  75
  76 Installing Tiger housenumber data for the US
  77 ============================================
  78
  79 Nominatim is able to use the official TIGER address set to complement the
  80 OSM housenumber data in the US. You can add TIGER data to your own Nominatim
  81 instance by following these steps:
  82
  83   1. Install the GDAL library and python bindings
  84
  85        * Ubuntu: `sudo apt-get install python-gdal`
  86        * CentOS: `sudo yum install gdal-python`
  87
  88   2. Get the TIGER 2015 data. You will need the EDGES files
  89      (3,234 zip files, 11GB total). Choose one of the two sources:
  90
  91          wget -r ftp://ftp2.census.gov/geo/tiger/TIGER2015/EDGES/
  92          wget -r ftp://mirror1.shellbot.com/census/geo/tiger/TIGER2015/EDGES/
  93
  94      The first one is the original source, the second a considerably faster
  95      mirror.
  96
  97   3. Convert the data into SQL statements (stored in data/tiger):
  98
  99          ./utils/imports.php --parse-tiger <tiger edge data directory>
 100
 101   4. Import the data into your Nominatim database:
 102
 103          ./utils/setup.php --import-tiger-data
 104
 105 Be warned that the import can take a very long time, especially if you
 106 import all of the US.
 107
 108
 109 Updates
 110 =======
 111
 112 There are many different possibilities to update your Nominatim database.
 113 The following section describes how to keep it up-to-date with osmosis.
 114 For a list of other methods see the output of `./utils/update.php --help`.
 115
 116 Installing the newest version of osmosis
 117 ----------------------------------------
 118
 119 The version of osmosis that comes with your distribution should be sufficient
 120 in most cases.
 121
 122 If you want to install it by hand, get the latest version from the
 123 [Osmosis website](http://wiki.openstreetmap.org/wiki/Osmosis). Then
 124 tell Nominatim to use this version by adding the following line to
 125 your `settings/local.php`:
 126
 127     @define('CONST_Osmosis_Binary', '/usr/local/bin/osmosis');
 128
 129 Setting up the update process
 130 -----------------------------
 131
 132 Next the update needs to be initialised. By default Nominatim is configured
 133 to update using the global minutely diffs.
 134
 135 If you want a different update source you will need to add some settings
 136 to `settings/local.php`. For example, to use the daily country extracts
 137 diffs for Ireland from geofabrik add the following:
 138
 139     // base URL of the replication service
 140     @define('CONST_Replication_Url', 'http://download.geofabrik.de/europe/ireland-and-northern-ireland-updates');
 141     // Process each update separately, osmosis cannot merge multiple updates
 142     @define('CONST_Replication_MaxInterval', '40000');
 143     // How often upstream publishes diffs
 144     @define('CONST_Replication_Update_Interval', '86400');
 145     // How long to sleep if no update found yet
 146     @define('CONST_Replication_Recheck_Interval', '900');
 147
 148
 149 Delete any existing `settings/configuration.txt`, then run the following command
 150 to create the osmosis configuration files:
 151
 152     ./utils/setup.php --osmosis-init
 153
 154 Enabling hierarchical updates
 155 -----------------------------
 156
 157 When a place is updated in the database, all places that contain this place
 158 in their address need to be updated as well. These hierarchical updates are
 159 disabled by default because they slow down the initial import.
 160 Enable them with the following command:
 161
 162     ./utils/setup.php --create-functions --enable-diff-updates
 163
 164 Updating Nominatim
 165 ------------------
 166
 167 The following command will keep your database constantly up to date:
 168
 169     ./utils/update.php --import-osmosis-all --no-npi
 170
 171 If you have imported multiple country extracts and want to keep them
 172 up-to-date, have a look at the script in
 173 (issue #60)[https://github.com/twain47/Nominatim/issues/60].
 174