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 Geofabrik.
  52
  53 Download the data to import and load the data with the following command:
  54
  55     ./utils/setup.php --osm-file <your data file> --all [--osm2pgsql-cache 28000] 2>&1 | tee setup.log
  56
  57 The --osm2pgsql-cache parameter is optional but strongly recommended for
  58 planet imports. It sets the node cache size for the osm2pgsql import part
  59 (see -C parameter in osm2pgsql help). 28GB are recommended for a full planet
  60 imports, for excerpts you can use less. Adapt to your available RAM to
  61 avoid swapping, never give more than 2/3 of RAM to osm2pgsql.
  62
  63
  64 Loading Additional Datasets
  65 ---------------------------
  66
  67 The following commands will create additional entries for countries and POI searches:
  68
  69     ./utils/specialphrases.php --countries > data/specialphrases_countries.sql
  70     psql -d nominatim -f data/specialphrases_countries.sql
  71     ./utils/specialphrases.php --wiki-import > data/specialphrases.sql
  72     psql -d nominatim -f data/specialphrases.sql
  73
  74
  75 Installing Tiger housenumber data for the US
  76 ============================================
  77
  78 Nominatim is able to use the official TIGER address set to complement the
  79 OSM housenumber data in the US. You can add TIGER data to your own Nominatim
  80 instance by following these steps:
  81
  82   1. Install the GDAL library and python bindings
  83
  84        Ubuntu: apt-get install python-gdal
  85        CentOS: yum install gdal-python
  86
  87   2. Get the TIGER 2015 data. You will need the EDGES files
  88      (3,234 zip files, 11GB total).
  89
  90        wget -r ftp://mirror1.shellbot.com/census/geo/tiger/TIGER2015/EDGES/
  91        (1gb/s preferred mirror) MIRROR HOSTED BY SHELLBOT, LTD.
  92
  93        OR:
  94
  95        wget -r ftp://ftp2.census.gov/geo/tiger/TIGER2015/EDGES/
  96        (500kb/s original source) HOSTED BY THE US CENSUS BUREAU
  97
  98   3. Convert the data into SQL statements (stored in data/tiger):
  99
 100        ./utils/imports.php --parse-tiger <tiger edge data directory>
 101
 102   4. Import the data into your Nominatim database:
 103
 104        ./utils/setup.php --import-tiger-data
 105
 106 Be warned that the import can take a very long time, especially if you
 107 import all of the US.
 108
 109
 110 Updates
 111 =======
 112
 113 There are many different possibilities to update your Nominatim database.
 114 The following section describes how to keep it up-to-date with osmosis.
 115 For a list of other methods see the output of ./utils/update.php --help.
 116
 117 Installing the newest version of osmosis
 118 ----------------------------------------
 119
 120 The version of osmosis that comes with your distribution should be sufficient
 121 in most cases.
 122
 123 If you want to install it by hand, get the latest version from the
 124 [Osmosis website](http://wiki.openstreetmap.org/wiki/Osmosis). Then
 125 tell Nominatim to use this version by adding the following line to
 126 your `settings/local.php`:
 127
 128     @define('CONST_Osmosis_Binary', '/usr/local/bin/osmosis');
 129
 130 Setting up the update process
 131 -----------------------------
 132
 133 Next the update needs to be initialised. By default Nominatim is configured
 134 to update using the global minutely diffs.
 135
 136 If you want a different update source you will need to add some settings
 137 to `settings/local.php`. For example, to use the daily country extracts
 138 diffs for Ireland from geofabrik add the following:
 139
 140     // base URL of the replication service
 141     @define('CONST_Replication_Url', 'http://download.geofabrik.de/europe/ireland-and-northern-ireland-updates');
 142     // Process each update separately, osmosis cannot merge multiple updates
 143     @define('CONST_Replication_MaxInterval', '40000');
 144     // How often upstream publishes diffs
 145     @define('CONST_Replication_Update_Interval', '86400');
 146     // How long to sleep if no update found yet
 147     @define('CONST_Replication_Recheck_Interval', '900');
 148
 149
 150 Delete existing 'settings/configuration.txt' then run the following command
 151 to create the osmosis configuration files:
 152
 153     ./utils/setup.php --osmosis-init
 154
 155 Enabling hierarchical updates
 156 -----------------------------
 157
 158 When a place is updated in the database, all places that contain this place
 159 in their address need to be updated as well. These hierarchical updates are
 160 disabled by default because they slow down the initial import.
 161 Enable them with the following command:
 162
 163     ./utils/setup.php --create-functions --enable-diff-updates
 164
 165 Updating Nominatim
 166 ------------------
 167
 168 The following command will keep your database constantly up to date:
 169
 170     ./utils/update.php --import-osmosis-all --no-npi
 171
 172 If you have imported multiple country extracts and want to keep them
 173 up-to-date, have a look at the script in
 174 (issue #60)[https://github.com/twain47/Nominatim/issues/60].
 175