mirror of
https://github.com/osm-search/Nominatim.git
synced 2026-02-26 11:08:13 +00:00
update documentation to recommend Python frontend
This commit is contained in:
@@ -268,27 +268,10 @@ nominatim reverse --lat 51 --lon 45
|
|||||||
```
|
```
|
||||||
|
|
||||||
If you want to run Nominatim as a service, you need to make a choice between
|
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
|
Make sure you have installed the right packages as per
|
||||||
[Installation](Installation.md#software).
|
[Installation](Installation.md#software).
|
||||||
|
|
||||||
#### Testing the PHP frontend
|
|
||||||
|
|
||||||
You can run a small test server with the PHP frontend like this:
|
|
||||||
|
|
||||||
```sh
|
|
||||||
nominatim serve
|
|
||||||
```
|
|
||||||
|
|
||||||
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
|
#### Testing the Python frontend
|
||||||
|
|
||||||
To run the test server against the Python frontend, you must choose a
|
To run the test server against the Python frontend, you must choose a
|
||||||
@@ -296,10 +279,10 @@ web framework to use, either starlette or falcon. Make sure the appropriate
|
|||||||
packages are installed. Then run
|
packages are installed. Then run
|
||||||
|
|
||||||
``` sh
|
``` sh
|
||||||
nominatim serve --engine falcon
|
nominatim serve
|
||||||
```
|
```
|
||||||
|
|
||||||
or
|
or, if you prefer to use Starlette instead of Falcon as webserver,
|
||||||
|
|
||||||
``` sh
|
``` sh
|
||||||
nominatim serve --engine starlette
|
nominatim serve --engine starlette
|
||||||
@@ -314,6 +297,24 @@ Do not use this test server in production.
|
|||||||
To run Nominatim via webservers like Apache or nginx, please continue reading
|
To run Nominatim via webservers like Apache or nginx, please continue reading
|
||||||
[Deploy the Python frontend](Deployment-Python.md).
|
[Deploy the Python frontend](Deployment-Python.md).
|
||||||
|
|
||||||
|
#### Testing the PHP frontend
|
||||||
|
|
||||||
|
You can run a small test server with the PHP frontend like this:
|
||||||
|
|
||||||
|
```sh
|
||||||
|
nominatim serve --engine php
|
||||||
|
```
|
||||||
|
|
||||||
|
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).
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## Enabling search by category phrases
|
## Enabling search by category phrases
|
||||||
|
|
||||||
|
|||||||
@@ -55,23 +55,24 @@ For running Nominatim:
|
|||||||
* [PyYaml](https://pyyaml.org/) (5.1+)
|
* [PyYaml](https://pyyaml.org/) (5.1+)
|
||||||
* [datrie](https://github.com/pytries/datrie)
|
* [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:
|
For running continuous updates:
|
||||||
|
|
||||||
* [pyosmium](https://osmcode.org/pyosmium/)
|
* [pyosmium](https://osmcode.org/pyosmium/)
|
||||||
|
|
||||||
For running the experimental Python frontend:
|
For running the Python frontend:
|
||||||
|
|
||||||
* one of the following web frameworks:
|
* one of the following web frameworks:
|
||||||
* [falcon](https://falconframework.org/) (3.0+)
|
* [falcon](https://falconframework.org/) (3.0+)
|
||||||
* [starlette](https://www.starlette.io/)
|
* [starlette](https://www.starlette.io/)
|
||||||
* [uvicorn](https://www.uvicorn.org/)
|
* [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
|
For dependencies for running tests and building documentation, see
|
||||||
the [Development section](../develop/Development-Environment.md).
|
the [Development section](../develop/Development-Environment.md).
|
||||||
|
|
||||||
|
|||||||
@@ -22,8 +22,8 @@ nav:
|
|||||||
- 'Basic Installation': 'admin/Installation.md'
|
- 'Basic Installation': 'admin/Installation.md'
|
||||||
- 'Import' : 'admin/Import.md'
|
- 'Import' : 'admin/Import.md'
|
||||||
- 'Update' : 'admin/Update.md'
|
- 'Update' : 'admin/Update.md'
|
||||||
- 'Deploy (PHP frontend)' : 'admin/Deployment-PHP.md'
|
|
||||||
- 'Deploy (Python frontend)' : 'admin/Deployment-Python.md'
|
- 'Deploy (Python frontend)' : 'admin/Deployment-Python.md'
|
||||||
|
- 'Deploy (PHP frontend)' : 'admin/Deployment-PHP.md'
|
||||||
- 'Nominatim UI' : 'admin/Setup-Nominatim-UI.md'
|
- 'Nominatim UI' : 'admin/Setup-Nominatim-UI.md'
|
||||||
- 'Advanced Installations' : 'admin/Advanced-Installations.md'
|
- 'Advanced Installations' : 'admin/Advanced-Installations.md'
|
||||||
- 'Maintenance' : 'admin/Maintenance.md'
|
- 'Maintenance' : 'admin/Maintenance.md'
|
||||||
|
|||||||
Reference in New Issue
Block a user