enable CI tests for Ubuntu 24

[nominatim.git] / docs / admin / Import.md

diff --git a/docs/admin/Import.md b/docs/admin/Import.md
index bcc33af81e05aee601d8fb88144151f9488c7b04..38cd0b740ff4ea37f90098f43dd8f461d590b733 100644 (file)
--- a/docs/admin/Import.md
+++ b/docs/admin/Import.md
@@ -1,22 +1,55 @@
 # Importing the Database
 
 The following instructions explain how to create a Nominatim database
 # Importing the Database
 
 The following instructions explain how to create a Nominatim database

-from an OSM planet file and how to keep the database up to date. It
-is assumed that you have already successfully installed the Nominatim
-software itself, if not return to the [installation page](Installation.md).
+from an OSM planet file. It is assumed that you have already successfully
+installed the Nominatim software itself and the `nominatim` tool can be found
+in your `PATH`. If this is not the case, return to the
+[installation page](Installation.md).

 
 

-## Configuration setup in settings/local.php
+## Creating the project directory

 
 

-The Nominatim server can be customized via the file `settings/local.php`
-in the build directory. Note that this is a PHP file, so it must always
-start like this:
+Before you start the import, you should create a project directory for your
+new database installation. This directory receives all data that is related
+to a single Nominatim setup: configuration, extra data, etc. Create a project
+directory apart from the Nominatim software and change into the directory:

 
 

-    <?php
+```
+mkdir ~/nominatim-project
+cd ~/nominatim-project
+```
+
+In the following, we refer to the project directory as `$PROJECT_DIR`. To be
+able to copy&paste instructions, you can export the appropriate variable:
+
+```
+export PROJECT_DIR=~/nominatim-project
+```
+
+The Nominatim tool assumes per default that the current working directory is
+the project directory but you may explicitly state a different directory using
+the `--project-dir` parameter. The following instructions assume that you run
+all commands from the project directory.
+
+!!! tip "Migration Tip"

 
 

-without any leading spaces.
+    Nominatim used to be run directly from the build directory until version 3.6.
+    Essentially, the build directory functioned as the project directory
+    for the database installation. This setup still works and can be useful for
+    development purposes. It is not recommended anymore for production setups.
+    Create a project directory that is separate from the Nominatim software.

 
 

-There are lots of configuration settings you can tweak. Have a look
-at `settings/default.php` for a full list. Most should have a sensible default.
+### Configuration setup in `.env`
+
+The Nominatim server can be customized via an `.env` configuration file in the 
+project directory. This is a file in [dotenv](https://github.com/theskumar/python-dotenv)
+format which looks the same as variable settings in a standard shell environment.
+You can also set the same configuration via environment variables. All
+settings have a `NOMINATIM_` prefix to avoid conflicts with other environment
+variables.
+
+There are lots of configuration settings you can tweak. A full reference
+can be found in the chapter [Configuration Settings](../customize/Settings.md).
+Most should have a sensible default.

 
 #### Flatnode files
 
 
 #### Flatnode files
 


@@ -24,12 +57,12 @@ If you plan to import a large dataset (e.g. Europe, North America, planet),
 you should also enable flatnode storage of node locations. With this
 setting enabled, node coordinates are stored in a simple file instead
 of the database. This will save you import time and disk storage.
 you should also enable flatnode storage of node locations. With this
 setting enabled, node coordinates are stored in a simple file instead
 of the database. This will save you import time and disk storage.

-Add to your `settings/local.php`:
+Add to your `.env`:

 
 

-    @define('CONST_Osm2pgsql_Flatnode_File', '/path/to/flatnode.file');
+    NOMINATIM_FLATNODE_FILE="/path/to/flatnode.file"

 
 Replace the second part with a suitable path on your system and make sure
 
 Replace the second part with a suitable path on your system and make sure

-the directory exists. There should be at least 64GB of free space.
+the directory exists. There should be at least 75GB of free space.

 
 ## Downloading additional data
 
 
 ## Downloading additional data
 


@@ -38,43 +71,51 @@ the directory exists. There should be at least 64GB of free space.
 Wikipedia can be used as an optional auxiliary data source to help indicate
 the importance of OSM features. Nominatim will work without this information
 but it will improve the quality of the results if this is installed.
 Wikipedia can be used as an optional auxiliary data source to help indicate
 the importance of OSM features. Nominatim will work without this information
 but it will improve the quality of the results if this is installed.

-This data is available as a binary download:
+This data is available as a binary download. Put it into your project directory:

 
 

-    cd $NOMINATIM_SOURCE_DIR/data
-    wget https://www.nominatim.org/data/wikimedia-importance.sql.gz
+    cd $PROJECT_DIR
+    wget https://nominatim.org/data/wikimedia-importance.sql.gz
+    wget -O secondary_importance.sql.gz https://nominatim.org/data/wikimedia-secondary-importance.sql.gz

 
 

-The file is about 400MB and adds around 4GB to Nominatim database.
+The files are about 400MB and add around 4GB to the Nominatim database. For
+more information about importance,
+see [Importance Customization](../customize/Importance.md).

 
 !!! tip
 
 !!! tip

-    If you forgot to download the wikipedia rankings, you can also add
-    importances after the import. Download the files, then run
-    `./utils/setup.php --import-wikipedia-articles`
-    and `./utils/update.php --recompute-importance`.
+    If you forgot to download the wikipedia rankings, then you can
+    also add importances after the import. Download the SQL files, then
+    run `nominatim refresh --wiki-data --secondary-importance --importance`.
+    Updating importances for a planet will take a couple of hours.

 
 

-### Great Britain, USA postcodes
+### External postcodes

 
 

-Nominatim can use postcodes from an external source to improve searches that
-involve a GB or US postcode. This data can be optionally downloaded:
+Nominatim can use postcodes from an external source to improve searching with
+postcodes. We provide precomputed postcodes sets for the US (using TIGER data)
+and the UK (using the [CodePoint OpenData set](https://osdatahub.os.uk/downloads/open/CodePointOpen).
+This data can be optionally downloaded into the project directory:

 
 

-    cd $NOMINATIM_SOURCE_DIR/data
-    wget https://www.nominatim.org/data/gb_postcode_data.sql.gz
-    wget https://www.nominatim.org/data/us_postcode_data.sql.gz
+    cd $PROJECT_DIR
+    wget https://nominatim.org/data/gb_postcodes.csv.gz
+    wget https://nominatim.org/data/us_postcodes.csv.gz

 
 

-## Choosing the Data to Import
+You can also add your own custom postcode sources, see
+[Customization of postcodes](../customize/Postcodes.md).
+
+## Choosing the data to import

 
 In its default setup Nominatim is configured to import the full OSM data
 set for the entire planet. Such a setup requires a powerful machine with
 
 In its default setup Nominatim is configured to import the full OSM data
 set for the entire planet. Such a setup requires a powerful machine with

-at least 64GB of RAM and around 800GB of SSD hard disks. Depending on your
+at least 64GB of RAM and around 900GB of SSD hard disks. Depending on your

 use case there are various ways to reduce the amount of data imported. This
 section discusses these methods. They can also be combined.
 
 ### Using an extract
 
 use case there are various ways to reduce the amount of data imported. This
 section discusses these methods. They can also be combined.
 
 ### Using an extract
 

-If you only need geocoding for a smaller region, then precomputed extracts
+If you only need geocoding for a smaller region, then precomputed OSM extracts

 are a good way to reduce the database size and import time.
 [Geofabrik](https://download.geofabrik.de) offers extracts for most countries.
 They even have daily updates which can be used with the update process described
 are a good way to reduce the database size and import time.
 [Geofabrik](https://download.geofabrik.de) offers extracts for most countries.
 They even have daily updates which can be used with the update process described

-below. There are also
+[in the next section](Update.md). There are also

 [other providers for extracts](https://wiki.openstreetmap.org/wiki/Planet.osm#Downloading).
 
 Please be aware that some extracts are not cut exactly along the country
 [other providers for extracts](https://wiki.openstreetmap.org/wiki/Planet.osm#Downloading).
 
 Please be aware that some extracts are not cut exactly along the country


@@ -86,25 +127,36 @@ that Nominatim cannot compute the areas for some administrative areas.
 About half of the data in Nominatim's database is not really used for serving
 the API. It is only there to allow the data to be updated from the latest
 changes from OSM. For many uses these dynamic updates are not really required.
 About half of the data in Nominatim's database is not really used for serving
 the API. It is only there to allow the data to be updated from the latest
 changes from OSM. For many uses these dynamic updates are not really required.

-If you don't plan to apply updates, the dynamic part of the database can be
-safely dropped using the following command:
+If you don't plan to apply updates, you can run the import with the
+`--no-updates` parameter. This will drop the dynamic part of the database as
+soon as it is not required anymore.
+
+You can also drop the dynamic part later using the following command:

 
 ```
 
 ```

-./utils/setup.php --drop
+nominatim freeze

 ```
 
 Note that you still need to provide for sufficient disk space for the initial
 import. So this option is particularly interesting if you plan to transfer the
 database or reuse the space later.
 
 ```
 
 Note that you still need to provide for sufficient disk space for the initial
 import. So this option is particularly interesting if you plan to transfer the
 database or reuse the space later.
 

+!!! warning
+    The data structure for updates are also required when adding additional data
+    after the import, for example [TIGER housenumber data](../customize/Tiger.md).
+    If you plan to use those, you must not use the `--no-updates` parameter.
+    Do a normal import, add the external data and once you are done with
+    everything run `nominatim freeze`.
+
+

 ### Reverse-only Imports
 
 If you only want to use the Nominatim database for reverse lookups or
 if you plan to use the installation only for exports to a
 ### Reverse-only Imports
 
 If you only want to use the Nominatim database for reverse lookups or
 if you plan to use the installation only for exports to a

-[photon](https://photon.komoot.de/) database, then you can set up a database
+[photon](https://photon.komoot.io/) database, then you can set up a database

 without search indexes. Add `--reverse-only` to your setup command above.
 
 without search indexes. Add `--reverse-only` to your setup command above.
 

-This saves about 5% of disk space.
+This saves about 5% of disk space, import time won't be significant faster.

 
 ### Filtering Imported Data
 
 
 ### Filtering Imported Data
 


@@ -112,37 +164,39 @@ Nominatim normally sets up a full search database containing administrative
 boundaries, places, streets, addresses and POI data. There are also other
 import styles available which only read selected data:
 
 boundaries, places, streets, addresses and POI data. There are also other
 import styles available which only read selected data:
 

-* **settings/import-admin.style**
+* **admin**

   Only import administrative boundaries and places.
   Only import administrative boundaries and places.

-* **settings/import-street.style**
+* **street**

   Like the admin style but also adds streets.
   Like the admin style but also adds streets.

-* **settings/import-address.style**
+* **address**

   Import all data necessary to compute addresses down to house number level.
   Import all data necessary to compute addresses down to house number level.

-* **settings/import-full.style**
+* **full**

   Default style that also includes points of interest.
   Default style that also includes points of interest.

-* **settings/import-extratags.style**
+* **extratags**

   Like the full style but also adds most of the OSM tags into the extratags
   column.
 
   Like the full style but also adds most of the OSM tags into the extratags
   column.
 

-The style can be changed with the configuration `CONST_Import_Style`.
+The style can be changed with the configuration `NOMINATIM_IMPORT_STYLE`.

 
 To give you an idea of the impact of using the different styles, the table
 below gives rough estimates of the final database size after import of a
 
 To give you an idea of the impact of using the different styles, the table
 below gives rough estimates of the final database size after import of a

-2018 planet and after using the `--drop` option. It also shows the time
-needed for the import on a machine with 64GB RAM, 4 CPUS and SSDs. Note that
-the given sizes are just an estimate meant for comparison of style requirements.
-Your planet import is likely to be larger as the OSM data grows with time.
+2020 planet and after using the `--drop` option. It also shows the time
+needed for the import on a machine with 64GB RAM, 4 CPUS and NVME disks.
+Note that the given sizes are just an estimate meant for comparison of
+style requirements. Your planet import is likely to be larger as the
+OSM data grows with time.

 
 style     | Import time  |  DB size   |  after drop
 ----------|--------------|------------|------------
 
 style     | Import time  |  DB size   |  after drop
 ----------|--------------|------------|------------

-admin     |    5h        |  190 GB    |   20 GB
-street    |   42h        |  400 GB    |  180 GB
-address   |   59h        |  500 GB    |  260 GB
-full      |   80h        |  575 GB    |  300 GB
-extratags |   80h        |  585 GB    |  310 GB
+admin     |    4h        |  215 GB    |   20 GB
+street    |   22h        |  440 GB    |  185 GB
+address   |   36h        |  545 GB    |  260 GB
+full      |   54h        |  640 GB    |  330 GB
+extratags |   54h        |  650 GB    |  340 GB

 
 

-You can also customize the styles further. For a description of the
-style format see [the development section](../develop/Import.md).
+You can also customize the styles further.
+A [description of the style format](../customize/Import-Styles.md)
+can be found in the customization guide.

 
 ## Initial import of the data
 
 
 ## Initial import of the data
 


@@ -150,15 +204,20 @@ style format see [the development section](../develop/Import.md).
     First try the import with a small extract, for example from
     [Geofabrik](https://download.geofabrik.de).
 
     First try the import with a small extract, for example from
     [Geofabrik](https://download.geofabrik.de).
 

-Download the data to import and load the data with the following command
-from the build directory:
+Download the data to import. Then issue the following command
+from the **project directory** to start the import:

 
 ```sh
 
 ```sh

-./utils/setup.php --osm-file <data file> --all 2>&1 | tee setup.log
+nominatim import --osm-file <data file> 2>&1 | tee setup.log

 ```
 
 ```
 

-***Note for full planet imports:*** Even on a perfectly configured machine
-the import of a full planet takes at least 2 days. Once you see messages
+The **project directory** is the one that you have set up at the beginning.
+See [creating the project directory](#creating-the-project-directory).
+
+### Notes on full planet imports
+
+Even on a perfectly configured machine
+the import of a full planet takes around 2 days. Once you see messages

 with `Rank .. ETA` appear, the indexing process has started. This part takes
 the most time. There are 30 ranks to process. Rank 26 and 30 are the most complex.
 They take each about a third of the total import time. If you have not reached
 with `Rank .. ETA` appear, the indexing process has started. This part takes
 the most time. There are 30 ranks to process. Rank 26 and 30 are the most complex.
 They take each about a third of the total import time. If you have not reached


@@ -167,11 +226,12 @@ configuration as it may not be optimal for the import.
 
 ### Notes on memory usage
 
 
 ### Notes on memory usage
 

-In the first step of the import Nominatim uses osm2pgsql to load the OSM data
-into the PostgreSQL database. This step is very demanding in terms of RAM usage.
-osm2pgsql and PostgreSQL are running in parallel at this point. PostgreSQL
-blocks at least the part of RAM that has been configured with the
-`shared_buffers` parameter during [PostgreSQL tuning](Installation#postgresql-tuning)
+In the first step of the import Nominatim uses [osm2pgsql](https://osm2pgsql.org)
+to load the OSM data into the PostgreSQL database. This step is very demanding
+in terms of RAM usage. osm2pgsql and PostgreSQL are running in parallel at 
+this point. PostgreSQL blocks at least the part of RAM that has been configured
+with the `shared_buffers` parameter during
+[PostgreSQL tuning](Installation.md#tuning-the-postgresql-database)

 and needs some memory on top of that. osm2pgsql needs at least 2GB of RAM for
 its internal data structures, potentially more when it has to process very large
 relations. In addition it needs to maintain a cache for node locations. The size
 and needs some memory on top of that. osm2pgsql needs at least 2GB of RAM for
 its internal data structures, potentially more when it has to process very large
 relations. In addition it needs to maintain a cache for node locations. The size


@@ -182,74 +242,95 @@ completely and leave the memory for the flatnode file. Nominatim will do this
 by default, so you do not need to configure anything in this case.
 
 For imports without a flatnode file, set `--osm2pgsql-cache` approximately to
 by default, so you do not need to configure anything in this case.
 
 For imports without a flatnode file, set `--osm2pgsql-cache` approximately to

-the size of the OSM pbf file (in MB) you are importing. Make sure you leave
-enough RAM for PostgreSQL and osm2pgsql as mentioned above. If the system starts
-swapping or you are getting out-of-memory errors, reduce the cache size or
-even consider using a flatnode file.
+the size of the OSM pbf file you are importing. The size needs to be given in
+MB. Make sure you leave enough RAM for PostgreSQL and osm2pgsql as mentioned
+above. If the system starts swapping or you are getting out-of-memory errors,
+reduce the cache size or even consider using a flatnode file.
+

 
 

-### Verify import finished
+### Testing the installation

 
 

-Run this script to verify all required tables and indices got created successfully.
+Run this script to verify that all required tables and indices got created
+successfully.

 
 ```sh
 
 ```sh

-./utils/check_import_finished.php
+nominatim admin --check-database

 ```
 
 ```
 

+Now you can try out your installation by executing a simple query on the
+command line:

 
 

-## Tuning the database
+``` sh
+nominatim search --query Berlin
+```

 
 

-Accurate word frequency information for search terms helps PostgreSQL's query
-planner to make the right decisions. Recomputing them can improve the performance
-of forward geocoding in particular under high load. To recompute word counts run:
+or, when you have a reverse-only installation:

 
 

-```sh
-./utils/update.php --recompute-word-counts
+``` sh
+nominatim reverse --lat 51 --lon 45

 ```
 
 ```
 

-This will take a couple of hours for a full planet installation. You can
-also defer that step to a later point in time when you realise that
-performance becomes an issue. Just make sure that updates are stopped before
-running this function.
+If you want to run Nominatim as a service, you need to make a choice between
+running the modern Python frontend and the legacy PHP frontend.
+Make sure you have installed the right packages as per
+[Installation](Installation.md#software).

 
 

-If you want to be able to search for places by their type through
-[special key phrases](https://wiki.openstreetmap.org/wiki/Nominatim/Special_Phrases)
-you also need to enable these key phrases like this:
+#### Testing the Python frontend

 
 

-    ./utils/specialphrases.php --wiki-import > specialphrases.sql
-    psql -d nominatim -f specialphrases.sql
+To run the test server against the Python frontend, you must choose a
+web framework to use, either starlette or falcon. Make sure the appropriate
+packages are installed. Then run

 
 

-Note that this command downloads the phrases from the wiki link above. You
-need internet access for the step.
+``` sh
+nominatim serve
+```

 
 

+or, if you prefer to use Starlette instead of Falcon as webserver,

 
 

-## Installing Tiger housenumber data for the US
+``` sh
+nominatim serve --engine starlette
+```
+
+Go to `http://localhost:8088/status.php` and you should see the message `OK`.
+You can also run a search query, e.g. `http://localhost:8088/search.php?q=Berlin`
+or, for reverse-only installations a reverse query,
+e.g. `http://localhost:8088/reverse.php?lat=27.1750090510034&lon=78.04209025`.

 
 

-Nominatim is able to use the official [TIGER](https://www.census.gov/geographies/mapping-files/time-series/geo/tiger-line-file.html)
-address set to complement the OSM house number data in the US. You can add
-TIGER data to your own Nominatim instance by following these steps. The
-entire US adds about 10GB to your database.
+Do not use this test server in production.
+To run Nominatim via webservers like Apache or nginx, please continue reading
+[Deploy the Python frontend](Deployment-Python.md).

 
 

-  1. Get preprocessed TIGER 2019 data and unpack it into the
-     data directory in your Nominatim sources:
+#### Testing the PHP frontend

 
 

-        cd Nominatim/data
-        wget https://nominatim.org/data/tiger2019-nominatim-preprocessed.tar.gz
-        tar xf tiger2019-nominatim-preprocessed.tar.gz
+You can run a small test server with the PHP frontend like this:

 
 

-    `data-source/us-tiger/README.md` explains how the data got preprocessed.
+```sh
+nominatim serve --engine php
+```

 
 

-  2. Import the data into your Nominatim database:
+Go to `http://localhost:8088/status.php` and you should see the message `OK`.
+You can also run a search query, e.g. `http://localhost:8088/search.php?q=Berlin`
+or, for reverse-only installations a reverse query,
+e.g. `http://localhost:8088/reverse.php?lat=27.1750090510034&lon=78.04209025`.

 
 

-        ./utils/setup.php --import-tiger-data
+Do not use this test server in production.
+To run Nominatim via webservers like Apache or nginx, please continue reading
+[Deploy the PHP frontend](Deployment-PHP.md).

 
 

-  3. Enable use of the Tiger data in your `settings/local.php` by adding:

 
 

-         @define('CONST_Use_US_Tiger_Data', true);

 
 

-  4. Apply the new settings:
+## Enabling search by category phrases
+
+To be able to search for places by their type using
+[special phrases](https://wiki.openstreetmap.org/wiki/Nominatim/Special_Phrases)
+you also need to import these key phrases like this:

 
 ```sh
 
 ```sh

-    ./utils/setup.php --create-functions --enable-diff-updates --create-partition-functions
+nominatim special-phrases --import-from-wiki

 ```
 
 ```
 

+Note that this command downloads the phrases from the wiki link above. You
+need internet access for the step.

 
 

+You can also import special phrases from a csv file, for more 
+information please see the [Customization part](../customize/Special-Phrases.md).