X-Git-Url: https://git.openstreetmap.org./nominatim.git/blobdiff_plain/e31a1f7ef1ca79ee92abbf40b691ce1311b15e44..f3c4196c758a7720aefc26a7043bf1c6553028e2:/docs/admin/Setup-Nominatim-UI.md diff --git a/docs/admin/Setup-Nominatim-UI.md b/docs/admin/Setup-Nominatim-UI.md index 9a6e163b..f6068278 100644 --- a/docs/admin/Setup-Nominatim-UI.md +++ b/docs/admin/Setup-Nominatim-UI.md @@ -10,14 +10,18 @@ installation. For more details, please also have a look at the ## Installing nominatim-ui -nominatim-ui does not need any special installation, just download, configure -and run it. +We provide regular releases of nominatim-ui that contain the packaged website. +They do not need any special installation. Just download, configure +and run it. Grab the latest release from +[nominatim-ui's Github release page](https://github.com/osm-search/nominatim-ui/releases) +and unpack it. You can use `nominatim-ui-x.x.x.tar.gz` or `nominatim-ui-x.x.x.zip`. -Clone the source from github: +Copy the example configuration into the right place: - git clone https://github.com/osm-search/nominatim-ui + cd nominatim-ui + cp dist/config.example.js dist/config.js -Adapt the configuration `dist/config.js` to your needs. You need at least +Now adapt the configuration to your needs. You need at least to change the `Nominatim_API_Endpoint` to point to your Nominatim installation. Then you can just test it locally by spinning up a webserver in the `dist` @@ -66,7 +70,7 @@ map $args $format { ~(^|&)format= other; } -# Determine from the URI and the format parameter aboce if forwarding is needed. +# Determine from the URI and the format parameter above if forwarding is needed. map $uri/$format $forward_to_ui { default 1; # The default is to forward. ~^/ui 0; # If the URI point to the UI already, we are done.