1 Importing a new database
2 ========================
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).
9 Configuration setup in settings/local.php
10 -----------------------------------------
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:
20 @define('CONST_Osm2pgsql_Flatnode_File', '/path/to/flatnode.file');
23 Downloading additional data
24 ---------------------------
26 ### Wikipedia rankings
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:
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
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.
42 Nominatim can use postcodes from an external source to improve searches that involve a UK postcode. This data can be optionally downloaded:
44 cd $NOMINATIM_SOURCE_DIR/data
45 wget http://www.nominatim.org/data/gb_postcode_data.sql.gz
48 Initial import of the data
49 --------------------------
51 **Important:** first try the import with a small excerpt, for example from
52 [Geofabrik](http://download.geofabrik.de).
54 Download the data to import and load the data with the following command:
56 ./utils/setup.php --osm-file <your data file> --all [--osm2pgsql-cache 28000] 2>&1 | tee setup.log
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.
65 Loading additional datasets
66 ---------------------------
68 The following commands will create additional entries for countries and POI searches:
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
76 Installing Tiger housenumber data for the US
77 ============================================
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:
83 1. Install the GDAL library and python bindings
85 * Ubuntu: `sudo apt-get install python-gdal`
86 * CentOS: `sudo yum install gdal-python`
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:
91 wget -r ftp://ftp2.census.gov/geo/tiger/TIGER2015/EDGES/
92 wget -r ftp://mirror1.shellbot.com/census/geo/tiger/TIGER2015/EDGES/
94 The first one is the original source, the second a considerably faster
97 3. Convert the data into SQL statements (stored in data/tiger):
99 ./utils/imports.php --parse-tiger <tiger edge data directory>
101 4. Import the data into your Nominatim database:
103 ./utils/setup.php --import-tiger-data
105 5. Enable use of the Tiger data in your `settings/local.php` by adding:
107 @define('CONST_Use_US_Tiger_Data', true);
109 6. Apply the new settings:
111 ./utils/setup.php --create-functions --enable-diff-updates --create-partition-functions
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.
120 There are many different possibilities to update your Nominatim database.
121 The following section describes how to keep it up-to-date with osmosis.
122 For a list of other methods see the output of `./utils/update.php --help`.
124 Installing the newest version of osmosis
125 ----------------------------------------
127 The version of osmosis that comes with your distribution should be sufficient
130 If you want to install it by hand, get the latest version from the
131 [Osmosis website](http://wiki.openstreetmap.org/wiki/Osmosis). Then
132 tell Nominatim to use this version by adding the following line to
133 your `settings/local.php`:
135 @define('CONST_Osmosis_Binary', '/usr/local/bin/osmosis');
137 Setting up the update process
138 -----------------------------
140 Next the update needs to be initialised. By default Nominatim is configured
141 to update using the global minutely diffs.
143 If you want a different update source you will need to add some settings
144 to `settings/local.php`. For example, to use the daily country extracts
145 diffs for Ireland from geofabrik add the following:
147 // base URL of the replication service
148 @define('CONST_Replication_Url', 'http://download.geofabrik.de/europe/ireland-and-northern-ireland-updates');
149 // Process each update separately, osmosis cannot merge multiple updates
150 @define('CONST_Replication_MaxInterval', '40000');
151 // How often upstream publishes diffs
152 @define('CONST_Replication_Update_Interval', '86400');
153 // How long to sleep if no update found yet
154 @define('CONST_Replication_Recheck_Interval', '900');
157 Delete any existing `settings/configuration.txt`, then run the following command
158 to create the osmosis configuration files:
160 ./utils/setup.php --osmosis-init
162 Enabling hierarchical updates
163 -----------------------------
165 When a place is updated in the database, all places that contain this place
166 in their address need to be updated as well. These hierarchical updates are
167 disabled by default because they slow down the initial import.
168 Enable them with the following command:
170 ./utils/setup.php --create-functions --enable-diff-updates
175 The following command will keep your database constantly up to date:
177 ./utils/update.php --import-osmosis-all --no-npi
179 If you have imported multiple country extracts and want to keep them
180 up-to-date, have a look at the script in
181 (issue #60)[https://github.com/twain47/Nominatim/issues/60].