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 successfully 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 Replace the second part with a suitable path on your system and make sure
  23 the directory exists. There should be at least 35GB of free space.
  24
  25 Downloading additional data
  26 ---------------------------
  27
  28 ### Wikipedia rankings
  29
  30 Wikipedia can be used as an optional auxiliary data source to help indicate
  31 the importance of osm features. Nominatim will work without this information
  32 but it will improve the quality of the results if this is installed.
  33 This data is available as a binary download:
  34
  35     cd $NOMINATIM_SOURCE_DIR/data
  36     wget http://www.nominatim.org/data/wikipedia_article.sql.bin
  37     wget http://www.nominatim.org/data/wikipedia_redirect.sql.bin
  38
  39 Combined the 2 files are around 1.5GB and add around 30GB to the install
  40 size of nominatim. They also increase the install time by an hour or so.
  41
  42 ### UK postcodes
  43
  44 Nominatim can use postcodes from an external source to improve searches that involve a UK postcode. This data can be optionally downloaded:
  45
  46     cd $NOMINATIM_SOURCE_DIR/data
  47     wget http://www.nominatim.org/data/gb_postcode_data.sql.gz
  48
  49
  50 Initial import of the data
  51 --------------------------
  52
  53 **Important:** first try the import with a small excerpt, for example from
  54 [Geofabrik](http://download.geofabrik.de).
  55
  56 Download the data to import and load the data with the following command:
  57
  58     ./utils/setup.php --osm-file <your data file> --all [--osm2pgsql-cache 28000] 2>&1 | tee setup.log
  59
  60 The `--osm2pgsql-cache` parameter is optional but strongly recommended for
  61 planet imports. It sets the node cache size for the osm2pgsql import part
  62 (see `-C` parameter in osm2pgsql help). 28GB are recommended for a full planet
  63 import, for excerpts you can use less. Adapt to your available RAM to
  64 avoid swapping, never give more than 2/3 of RAM to osm2pgsql.
  65
  66
  67 Loading additional datasets
  68 ---------------------------
  69
  70 The following commands will create additional entries for POI searches:
  71
  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 and the unzip tool
  84
  85        * Ubuntu: `sudo apt-get install python-gdal unzip`
  86        * CentOS: `sudo yum install gdal-python unzip`
  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   5. Enable use of the Tiger data in your `settings/local.php` by adding:
 106
 107          @define('CONST_Use_US_Tiger_Data', true);
 108
 109   6. Apply the new settings:
 110
 111          ./utils/setup.php --create-functions --enable-diff-updates --create-partition-functions
 112
 113 Be warned that the import can take a very long time, especially if you
 114 import all of the US. The entire US adds about 10GB to your database.
 115
 116
 117 Updates
 118 =======
 119
 120 There are many different possibilities to update your Nominatim database.
 121 The following section describes how to keep it up-to-date with Pyosmium.
 122 For a list of other methods see the output of `./utils/update.php --help`.
 123
 124 Installing the newest version of Pyosmium
 125 -----------------------------------------
 126
 127 It is recommended to install Pyosmium via pip:
 128
 129     pip install --user osmium
 130
 131 Nominatim needs a tool called `pyosmium-get-updates` that comes with
 132 Pyosmium. You need to tell Nominatim where to find it. Add the
 133 following line to your `settings/local.php`:
 134
 135     @define('CONST_Pyosmium_Binary', '/home/user/.local/bin/pyosmium-get-changes');
 136
 137 The path above is fine if you used the `--user` parameter with pip.
 138 Replace `user` with your user name.
 139
 140 Setting up the update process
 141 -----------------------------
 142
 143 Next the update needs to be initialised. By default Nominatim is configured
 144 to update using the global minutely diffs.
 145
 146 If you want a different update source you will need to add some settings
 147 to `settings/local.php`. For example, to use the daily country extracts
 148 diffs for Ireland from geofabrik add the following:
 149
 150     // base URL of the replication service
 151     @define('CONST_Replication_Url', 'http://download.geofabrik.de/europe/ireland-and-northern-ireland-updates');
 152     // How often upstream publishes diffs
 153     @define('CONST_Replication_Update_Interval', '86400');
 154     // How long to sleep if no update found yet
 155     @define('CONST_Replication_Recheck_Interval', '900');
 156
 157 To set up the update process now run the following command:
 158
 159     ./utils/update.php --init-updates
 160
 161 It outputs the date where updates will start. Recheck that this date is
 162 what you expect.
 163
 164 The --init-updates command needs to be rerun whenever the replication service
 165 is changed.
 166
 167 Updating Nominatim
 168 ------------------
 169
 170 The following command will keep your database constantly up to date:
 171
 172     ./utils/update.php --import-osmosis-all
 173
 174 If you have imported multiple country extracts and want to keep them
 175 up-to-date, have a look at the script in
 176 [issue #60](https://github.com/openstreetmap/Nominatim/issues/60).
 177