]> git.openstreetmap.org Git - nominatim.git/blob - docs/Import-and-Update.md
Mention explicitly that Osmosis is not required.
[nominatim.git] / 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 *NOTE:* you'll need to download the Wikipedia rankings before performing
43 the initial import of the data if you want the rankings applied to the
44 loaded data.
45
46 ### UK postcodes
47
48 Nominatim can use postcodes from an external source to improve searches that involve a UK postcode. This data can be optionally downloaded: 
49
50     cd $NOMINATIM_SOURCE_DIR/data
51     wget http://www.nominatim.org/data/gb_postcode_data.sql.gz
52
53
54 Initial import of the data
55 --------------------------
56
57 **Important:** first try the import with a small excerpt, for example from
58 [Geofabrik](http://download.geofabrik.de).
59
60 Download the data to import and load the data with the following command:
61
62     ./utils/setup.php --osm-file <your data file> --all [--osm2pgsql-cache 28000] 2>&1 | tee setup.log
63
64 The `--osm2pgsql-cache` parameter is optional but strongly recommended for
65 planet imports. It sets the node cache size for the osm2pgsql import part
66 (see `-C` parameter in osm2pgsql help). 28GB are recommended for a full planet
67 import, for excerpts you can use less. Adapt to your available RAM to
68 avoid swapping, never give more than 2/3 of RAM to osm2pgsql.
69
70
71 Loading additional datasets
72 ---------------------------
73
74 The following commands will create additional entries for POI searches:
75
76     ./utils/specialphrases.php --wiki-import > specialphrases.sql
77     psql -d nominatim -f specialphrases.sql
78
79
80 Installing Tiger housenumber data for the US
81 ============================================
82
83 Nominatim is able to use the official TIGER address set to complement the
84 OSM housenumber data in the US. You can add TIGER data to your own Nominatim
85 instance by following these steps:
86
87   1. Install the GDAL library and python bindings and the unzip tool
88
89        * Ubuntu: `sudo apt-get install python-gdal unzip`
90        * CentOS: `sudo yum install gdal-python unzip`
91
92   2. Get the TIGER 2015 data. You will need the EDGES files
93      (3,234 zip files, 11GB total). Choose one of the two sources:
94
95          wget -r ftp://ftp2.census.gov/geo/tiger/TIGER2015/EDGES/
96          wget -r ftp://mirror1.shellbot.com/census/geo/tiger/TIGER2015/EDGES/
97
98      The first one is the original source, the second a considerably faster
99      mirror.
100
101   3. Convert the data into SQL statements (stored in data/tiger): 
102
103          ./utils/imports.php --parse-tiger <tiger edge data directory>
104
105   4. Import the data into your Nominatim database: 
106
107          ./utils/setup.php --import-tiger-data
108
109   5. Enable use of the Tiger data in your `settings/local.php` by adding:
110
111          @define('CONST_Use_US_Tiger_Data', true);
112
113   6. Apply the new settings:
114
115          ./utils/setup.php --create-functions --enable-diff-updates --create-partition-functions
116
117 Be warned that the import can take a very long time, especially if you
118 import all of the US. The entire US adds about 10GB to your database.
119
120
121 Updates
122 =======
123
124 There are many different possibilities to update your Nominatim database.
125 The following section describes how to keep it up-to-date with Pyosmium.
126 For a list of other methods see the output of `./utils/update.php --help`.
127
128 Installing the newest version of Pyosmium
129 -----------------------------------------
130
131 It is recommended to install Pyosmium via pip:
132
133     pip install --user osmium
134
135 Nominatim needs a tool called `pyosmium-get-updates` that comes with
136 Pyosmium. You need to tell Nominatim where to find it. Add the
137 following line to your `settings/local.php`:
138
139     @define('CONST_Pyosmium_Binary', '/home/user/.local/bin/pyosmium-get-changes');
140
141 The path above is fine if you used the `--user` parameter with pip.
142 Replace `user` with your user name.
143
144 Setting up the update process
145 -----------------------------
146
147 Next the update needs to be initialised. By default Nominatim is configured
148 to update using the global minutely diffs.
149
150 If you want a different update source you will need to add some settings
151 to `settings/local.php`. For example, to use the daily country extracts
152 diffs for Ireland from geofabrik add the following:
153
154     // base URL of the replication service
155     @define('CONST_Replication_Url', 'http://download.geofabrik.de/europe/ireland-and-northern-ireland-updates');
156     // How often upstream publishes diffs
157     @define('CONST_Replication_Update_Interval', '86400');
158     // How long to sleep if no update found yet
159     @define('CONST_Replication_Recheck_Interval', '900');
160
161 To set up the update process now run the following command:
162
163     ./utils/update.php --init-updates
164
165 It outputs the date where updates will start. Recheck that this date is
166 what you expect.
167
168 The --init-updates command needs to be rerun whenever the replication service
169 is changed.
170
171 Updating Nominatim
172 ------------------
173
174 The following command will keep your database constantly up to date:
175
176     ./utils/update.php --import-osmosis-all
177
178 (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.)
179
180 If you have imported multiple country extracts and want to keep them
181 up-to-date, have a look at the script in
182 [issue #60](https://github.com/openstreetmap/Nominatim/issues/60).
183