From: Sarah Hoffmann <lonvia@denofr.de>
Date: Thu, 15 Feb 2024 18:48:32 +0000 (+0100)
Subject: update documentation to recommend Python frontend
X-Git-Tag: v4.4.0~14^2~5
X-Git-Url: https://git.openstreetmap.org./nominatim.git/commitdiff_plain/ffb467028e138d174af4b3b52472f4a349ffceb5?ds=sidebyside

update documentation to recommend Python frontend
---

diff --git a/docs/admin/Import.md b/docs/admin/Import.md
index 0fd5ec29..b31066d3 100644
--- a/docs/admin/Import.md
+++ b/docs/admin/Import.md
@@ -268,18 +268,26 @@ 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.
+running the modern Python frontend and the legacy PHP frontend.
 Make sure you have installed the right packages as per
 [Installation](Installation.md#software).
 
-#### Testing the PHP frontend
+#### Testing the Python frontend
 
-You can run a small test server with the PHP frontend like this:
+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
+``` sh
 nominatim serve
 ```
 
+or, if you prefer to use Starlette instead of Falcon as webserver,
+
+``` 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,
@@ -287,22 +295,14 @@ 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
+[Deploy the Python frontend](Deployment-Python.md).
 
-``` sh
-nominatim serve --engine falcon
-```
+#### Testing the PHP frontend
 
-or
+You can run a small test server with the PHP frontend like this:
 
-``` sh
-nominatim serve --engine starlette
+```sh
+nominatim serve --engine php
 ```
 
 Go to `http://localhost:8088/status.php` and you should see the message `OK`.
@@ -312,7 +312,8 @@ 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).
+[Deploy the PHP frontend](Deployment-PHP.md).
+
 
 
 ## Enabling search by category phrases
diff --git a/docs/admin/Installation.md b/docs/admin/Installation.md
index 89e56c6e..ef6bd081 100644
--- a/docs/admin/Installation.md
+++ b/docs/admin/Installation.md
@@ -55,23 +55,24 @@ For running Nominatim:
   * [PyYaml](https://pyyaml.org/) (5.1+)
   * [datrie](https://github.com/pytries/datrie)
 
-When running the PHP frontend:
-
-  * [PHP](https://php.net) (7.3+)
-  * PHP-pgsql
-  * PHP-intl (bundled with PHP)
-
 For running continuous updates:
 
   * [pyosmium](https://osmcode.org/pyosmium/)
 
-For running the experimental Python frontend:
+For running the Python frontend:
 
   * one of the following web frameworks:
     * [falcon](https://falconframework.org/) (3.0+)
     * [starlette](https://www.starlette.io/)
   * [uvicorn](https://www.uvicorn.org/)
 
+For running the legacy PHP frontend:
+
+  * [PHP](https://php.net) (7.3+)
+  * PHP-pgsql
+  * PHP-intl (bundled with PHP)
+
+
 For dependencies for running tests and building documentation, see
 the [Development section](../develop/Development-Environment.md).
 
diff --git a/docs/mkdocs.yml b/docs/mkdocs.yml
index f332640f..74465d1a 100644
--- a/docs/mkdocs.yml
+++ b/docs/mkdocs.yml
@@ -22,8 +22,8 @@ nav:
         - 'Basic Installation': 'admin/Installation.md'
         - 'Import' : 'admin/Import.md'
         - 'Update' : 'admin/Update.md'
-        - 'Deploy (PHP frontend)' : 'admin/Deployment-PHP.md'
         - 'Deploy (Python frontend)' : 'admin/Deployment-Python.md'
+        - 'Deploy (PHP frontend)' : 'admin/Deployment-PHP.md'
         - 'Nominatim UI'  : 'admin/Setup-Nominatim-UI.md'
         - 'Advanced Installations' : 'admin/Advanced-Installations.md'
         - 'Maintenance' : 'admin/Maintenance.md'