Merge pull request #3260 from lonvia/improve-catgeory-search

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

diff --git a/docs/admin/Import.md b/docs/admin/Import.md
index 91b927287d8fdc7b4c961b833ff33178015863d3..0fd5ec29b4256a357fee4b11bb036ec47aa8a0d3 100644 (file)
--- a/docs/admin/Import.md
+++ b/docs/admin/Import.md
@@ -74,31 +74,14 @@ but it will improve the quality of the results if this is installed.
 This data is available as a binary download. Put it into your project directory:
 
     cd $PROJECT_DIR
 This data is available as a binary download. Put it into your project directory:
 
     cd $PROJECT_DIR

-    wget https://www.nominatim.org/data/wikimedia-importance.sql.gz
+    wget https://nominatim.org/data/wikimedia-importance.sql.gz

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

-### OSM views 
-OSM publishes aggregate map access numbers that are generated based on the users’ 
-behavior when viewing locations on the map. This data is also optional and 
-it complements wikipedia/wikidata rankings to further enhance the search results
-if added.
-OSM views data is avalaible as a GeoTIFF file. Put it into your project directory:
-
-    cd $PROJECT_DIR
-    wget https://qrank.wmcloud.org/download/osmviews.tiff
-
-The file is about 380MB and adds around 4GB to the Nominatim database. Importing
-OSM views into Nominatim takes a little over 3 hours.
-
-!!! warning
-    Importing OSM views is currently an experimental feature. OSM views data are
-    not yet included in the importance values calculations.
-

 !!! tip
 !!! tip

-    If you forgot to download the wikipedia rankings or OSM views, then you can 
-    also add importances after the import. To add both, download their files, then 
-    run `nominatim refresh --wiki-data --osm-views --importance`. Updating 
+    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 --importance`. Updating

     importances for a planet will take a couple of hours.
 
 ### External postcodes
     importances for a planet will take a couple of hours.
 
 ### External postcodes


@@ -109,8 +92,8 @@ and the UK (using the [CodePoint OpenData set](https://osdatahub.os.uk/downloads
 This data can be optionally downloaded into the project directory:
 
     cd $PROJECT_DIR
 This data can be optionally downloaded into the project directory:
 
     cd $PROJECT_DIR

-    wget https://www.nominatim.org/data/gb_postcodes.csv.gz
-    wget https://www.nominatim.org/data/us_postcodes.csv.gz
+    wget https://nominatim.org/data/gb_postcodes.csv.gz
+    wget https://nominatim.org/data/us_postcodes.csv.gz

 
 You can also add your own custom postcode sources, see
 [Customization of postcodes](../customize/Postcodes.md).
 
 You can also add your own custom postcode sources, see
 [Customization of postcodes](../customize/Postcodes.md).


@@ -271,26 +254,70 @@ successfully.
 nominatim admin --check-database
 ```
 
 nominatim admin --check-database
 ```
 

-Now you can try out your installation by running:
+Now you can try out your installation by executing a simple query on the
+command line:
+
+``` sh
+nominatim search --query Berlin
+```
+
+or, when you have a reverse-only installation:
+
+``` sh
+nominatim reverse --lat 51 --lon 45
+```
+
+If you want to run Nominatim as a service, you need to make a choice between
+running the traditional PHP frontend or the new experimental Python frontend.
+Make sure you have installed the right packages as per
+[Installation](Installation.md#software).
+
+#### Testing the PHP frontend
+
+You can run a small test server with the PHP frontend like this:

 
 ```sh
 nominatim serve
 ```
 
 
 ```sh
 nominatim 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`.
+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`.
+
+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).
+
+#### Testing the Python frontend
+
+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
+
+``` sh
+nominatim serve --engine falcon
+```
+
+or
+
+``` 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`.

 
 

-Note that search query is not supported for reverse-only imports. You can run a
-reverse query, e.g. `http://localhost:8088/reverse.php?lat=27.1750090510034&lon=78.04209025`.
+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).

 
 

-To run Nominatim via webservers like Apache or nginx, please read the
-[Deployment chapter](Deployment.md).

 
 

-## Adding search through category phrases
+## Enabling search by category phrases

 
 

-If you want to be able to search for places by their type through
+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:
 
 [special phrases](https://wiki.openstreetmap.org/wiki/Nominatim/Special_Phrases)
 you also need to import these key phrases like this: