Merge pull request #2135 from lonvia/python-frontend

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

diff --git a/docs/admin/Import.md b/docs/admin/Import.md
index bcc33af81e05aee601d8fb88144151f9488c7b04..01d012305927ad27c8c87eb858058fb15e71c62c 100644 (file)
--- a/docs/admin/Import.md
+++ b/docs/admin/Import.md
@@ -5,18 +5,17 @@ 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).
 
 is assumed that you have already successfully installed the Nominatim
 software itself, if not return to the [installation page](Installation.md).
 

-## Configuration setup in settings/local.php
+## Configuration setup in `.env`

 
 

-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:
-
-    <?php
-
-without any leading spaces.
+The Nominatim server can be customized via a `.env` in the build 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. Have a look
 
 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.
+at `settings/env.default` for a full list. Most should have a sensible default.

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


@@ -24,12 +23,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
 


@@ -43,13 +42,12 @@ This data is available as a binary download:
     cd $NOMINATIM_SOURCE_DIR/data
     wget https://www.nominatim.org/data/wikimedia-importance.sql.gz
 
     cd $NOMINATIM_SOURCE_DIR/data
     wget https://www.nominatim.org/data/wikimedia-importance.sql.gz
 

-The file is about 400MB and adds around 4GB to Nominatim database.
+The file is about 400MB and adds around 4GB to the Nominatim database.

 
 !!! tip
     If you forgot to download the wikipedia rankings, you can also add
     importances after the import. Download the files, then run
 
 !!! 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`.
+    `./nominatim refresh --wiki-data --importance`.

 
 ### Great Britain, USA postcodes
 
 
 ### Great Britain, USA postcodes
 


@@ -60,21 +58,21 @@ involve a GB or US postcode. This data can be optionally downloaded:
     wget https://www.nominatim.org/data/gb_postcode_data.sql.gz
     wget https://www.nominatim.org/data/us_postcode_data.sql.gz
 
     wget https://www.nominatim.org/data/gb_postcode_data.sql.gz
     wget https://www.nominatim.org/data/us_postcode_data.sql.gz
 

-## Choosing the Data to Import
+## 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). 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,11 +84,14 @@ 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
 ```
 
 Note that you still need to provide for sufficient disk space for the initial


@@ -124,25 +125,27 @@ import styles available which only read selected data:
   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](../develop/Import.md#configuring-the-import) 
+can be found in the development section.

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


@@ -150,15 +153,17 @@ 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 **build 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
+### 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 +172,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#postgresql-tuning)

 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,19 +188,34 @@ 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
+### Verify the import

 
 Run this script to verify all required tables and indices got created successfully.
 
 ```sh
 
 Run this script to verify all required tables and indices got created successfully.
 
 ```sh

-./utils/check_import_finished.php
+./nominatim check-database
+```
+
+### Testing the installation
+
+Now you can try out your installation by running:
+
+```sh
+make serve

 ```
 
 ```
 

+This runs a small test server normally used for development. You can use it
+to verify that your installation is working. 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`.
+
+To run Nominatim via webservers like Apache or nginx, please read the
+[Deployment chapter](Deployment.md).

 
 ## Tuning the database
 
 
 ## Tuning the database
 


@@ -203,7 +224,7 @@ planner to make the right decisions. Recomputing them can improve the performanc
 of forward geocoding in particular under high load. To recompute word counts run:
 
 ```sh
 of forward geocoding in particular under high load. To recompute word counts run:
 
 ```sh

-./utils/update.php --recompute-word-counts
+./nominatim refresh --word-counts

 ```
 
 This will take a couple of hours for a full planet installation. You can
 ```
 
 This will take a couple of hours for a full planet installation. You can


@@ -215,7 +236,7 @@ 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:
 
 [special key phrases](https://wiki.openstreetmap.org/wiki/Nominatim/Special_Phrases)
 you also need to enable these key phrases like this:
 

-    ./utils/specialphrases.php --wiki-import > specialphrases.sql
+    ./nominatim special-phrases --from-wiki > specialphrases.sql

     psql -d nominatim -f specialphrases.sql
 
 Note that this command downloads the phrases from the wiki link above. You
     psql -d nominatim -f specialphrases.sql
 
 Note that this command downloads the phrases from the wiki link above. You


@@ -232,24 +253,24 @@ entire US adds about 10GB to your database.
   1. Get preprocessed TIGER 2019 data and unpack it into the
      data directory in your Nominatim sources:
 
   1. Get preprocessed TIGER 2019 data and unpack it into the
      data directory in your Nominatim sources:
 

-        cd Nominatim/data

         wget https://nominatim.org/data/tiger2019-nominatim-preprocessed.tar.gz
         tar xf tiger2019-nominatim-preprocessed.tar.gz
 
         wget https://nominatim.org/data/tiger2019-nominatim-preprocessed.tar.gz
         tar xf tiger2019-nominatim-preprocessed.tar.gz
 

-    `data-source/us-tiger/README.md` explains how the data got preprocessed.
-

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

-        ./utils/setup.php --import-tiger-data
+        ./nominatim add-data --tiger-data tiger

 
 

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

 
 

-         @define('CONST_Use_US_Tiger_Data', true);
+         NOMINATIM_USE_US_TIGER_DATA=yes

 
   4. Apply the new settings:
 
 ```sh
 
   4. Apply the new settings:
 
 ```sh

-    ./utils/setup.php --create-functions --enable-diff-updates --create-partition-functions
+    ./nominatim refresh --functions

 ```
 
 
 ```
 
 

+See the [developer's guide](../develop/data-sources.md#us-census-tiger) for more
+information on how the data got preprocessed.
+