Merge remote-tracking branch 'upstream/master'

[nominatim.git] / docs / Import_and_update.md

diff --git a/docs/Import_and_update.md b/docs/Import_and_update.md
index 80e8bf477f44a533425d2456f4ec1c2cd4440903..15aec256b9073715e3c933f3b7173c3b308ad5b0 100644 (file)
--- a/docs/Import_and_update.md
+++ b/docs/Import_and_update.md
@@ -19,6 +19,8 @@ Add to your settings/local.php:
 
     @define('CONST_Osm2pgsql_Flatnode_File', '/path/to/flatnode.file');
 
 
     @define('CONST_Osm2pgsql_Flatnode_File', '/path/to/flatnode.file');
 

+Replace the second part with a suitable path on your system and make sure
+the directory exists. There should be at least 35GB of free space.

 
 Downloading additional data
 ---------------------------
 
 Downloading additional data
 ---------------------------


@@ -45,10 +47,11 @@ Nominatim can use postcodes from an external source to improve searches that inv
     wget http://www.nominatim.org/data/gb_postcode_data.sql.gz
 
 
     wget http://www.nominatim.org/data/gb_postcode_data.sql.gz
 
 

-Initial Import of the Data
+Initial import of the data

 --------------------------
 
 --------------------------
 

-**Important:** first try the import with a small excerpt, for example from Geofabrik.
+**Important:** first try the import with a small excerpt, for example from
+[Geofabrik](http://download.geofabrik.de).

 
 Download the data to import and load the data with the following command:
 
 
 Download the data to import and load the data with the following command:
 


@@ -57,19 +60,17 @@ Download the data to import and load the data with the following command:
 The --osm2pgsql-cache parameter is optional but strongly recommended for
 planet imports. It sets the node cache size for the osm2pgsql import part
 (see -C parameter in osm2pgsql help). 28GB are recommended for a full planet
 The --osm2pgsql-cache parameter is optional but strongly recommended for
 planet imports. It sets the node cache size for the osm2pgsql import part
 (see -C parameter in osm2pgsql help). 28GB are recommended for a full planet

-imports, for excerpts you can use less. Adapt to your available RAM to
+import, for excerpts you can use less. Adapt to your available RAM to

 avoid swapping, never give more than 2/3 of RAM to osm2pgsql.
 
 
 avoid swapping, never give more than 2/3 of RAM to osm2pgsql.
 
 

-Loading Additional Datasets
+Loading additional datasets

 ---------------------------
 
 ---------------------------
 

-The following commands will create additional entries for countries and POI searches:
+The following commands will create additional entries for POI searches:

 
 

-    ./utils/specialphrases.php --countries > data/specialphrases_countries.sql
-    psql -d nominatim -f data/specialphrases_countries.sql
-    ./utils/specialphrases.php --wiki-import > data/specialphrases.sql
-    psql -d nominatim -f data/specialphrases.sql
+    ./utils/specialphrases.php --wiki-import > specialphrases.sql
+    psql -d nominatim -f specialphrases.sql

 
 
 Installing Tiger housenumber data for the US
 
 
 Installing Tiger housenumber data for the US


@@ -81,30 +82,36 @@ instance by following these steps:
 
   1. Install the GDAL library and python bindings
 
 
   1. Install the GDAL library and python bindings
 

-       Ubuntu: apt-get install python-gdal
-       CentOS: yum install gdal-python
+       * Ubuntu: `sudo apt-get install python-gdal`
+       * CentOS: `sudo yum install gdal-python`

 
   2. Get the TIGER 2015 data. You will need the EDGES files
 
   2. Get the TIGER 2015 data. You will need the EDGES files

-     (3,234 zip files, 11GB total).
+     (3,234 zip files, 11GB total). Choose one of the two sources:

 
 

-       wget -r ftp://mirror1.shellbot.com/census/geo/tiger/TIGER2015/EDGES/
-       (1gb/s preferred mirror) MIRROR HOSTED BY SHELLBOT, LTD.
+         wget -r ftp://ftp2.census.gov/geo/tiger/TIGER2015/EDGES/
+         wget -r ftp://mirror1.shellbot.com/census/geo/tiger/TIGER2015/EDGES/

 
 

-       OR:
-
-       wget -r ftp://ftp2.census.gov/geo/tiger/TIGER2015/EDGES/
-       (500kb/s original source) HOSTED BY THE US CENSUS BUREAU
+     The first one is the original source, the second a considerably faster
+     mirror.

 
   3. Convert the data into SQL statements (stored in data/tiger): 
 
 
   3. Convert the data into SQL statements (stored in data/tiger): 
 

-       ./utils/imports.php --parse-tiger <tiger edge data directory>
+         ./utils/imports.php --parse-tiger <tiger edge data directory>

 
   4. Import the data into your Nominatim database: 
 
 
   4. Import the data into your Nominatim database: 
 

-       ./utils/setup.php --import-tiger-data
+         ./utils/setup.php --import-tiger-data
+
+  5. Enable use of the Tiger data in your `settings/local.php` by adding:
+
+         @define('CONST_Use_US_Tiger_Data', true);
+
+  6. Apply the new settings:
+
+        ./utils/setup.php --create-functions --enable-diff-updates --create-partition-functions

 
 Be warned that the import can take a very long time, especially if you
 
 Be warned that the import can take a very long time, especially if you

-import all of the US.
+import all of the US. The entire US adds about 10GB to your database.

 
 
 Updates
 
 
 Updates


@@ -112,7 +119,7 @@ Updates
 
 There are many different possibilities to update your Nominatim database.
 The following section describes how to keep it up-to-date with osmosis.
 
 There are many different possibilities to update your Nominatim database.
 The following section describes how to keep it up-to-date with osmosis.

-For a list of other methods see the output of ./utils/update.php --help.
+For a list of other methods see the output of `./utils/update.php --help`.

 
 Installing the newest version of osmosis
 ----------------------------------------
 
 Installing the newest version of osmosis
 ----------------------------------------


@@ -147,7 +154,7 @@ diffs for Ireland from geofabrik add the following:
     @define('CONST_Replication_Recheck_Interval', '900');
 
 
     @define('CONST_Replication_Recheck_Interval', '900');
 
 

-Delete existing 'settings/configuration.txt' then run the following command
+Delete any existing `settings/configuration.txt`, then run the following command

 to create the osmosis configuration files:
 
     ./utils/setup.php --osmosis-init
 to create the osmosis configuration files:
 
     ./utils/setup.php --osmosis-init


@@ -171,5 +178,5 @@ The following command will keep your database constantly up to date:
 
 If you have imported multiple country extracts and want to keep them
 up-to-date, have a look at the script in
 
 If you have imported multiple country extracts and want to keep them
 up-to-date, have a look at the script in

-(issue #60)[https://github.com/twain47/Nominatim/issues/60].
+[issue #60](https://github.com/twain47/Nominatim/issues/60).