From: Sarah Hoffmann <lonvia@denofr.de>
Date: Mon, 2 Nov 2020 15:34:17 +0000 (+0100)
Subject: docs: add migration hints for removed UI
X-Git-Tag: v3.6.0~37^2~1
X-Git-Url: https://git.openstreetmap.org./nominatim.git/commitdiff_plain/e31a1f7ef1ca79ee92abbf40b691ce1311b15e44

docs: add migration hints for removed UI
---

diff --git a/docs/admin/Migration.md b/docs/admin/Migration.md
index fb766ba6..66b4c28b 100644
--- a/docs/admin/Migration.md
+++ b/docs/admin/Migration.md
@@ -8,6 +8,18 @@ SQL statements should be executed from the PostgreSQL commandline. Execute
 
 ## 3.5.0 -> master
 
+### Removal of html output
+
+The debugging UI is no longer directly provided with Nominatim. Instead we
+now provide a simple Javascript application. Please refer to
+[Setting up the Nominatim UI](../Setup-Nominatim-UI) for details on how to
+set up the UI.
+
+The icons served together with the API responses have been moved to the
+nominatim-ui project as well. If you want to keep the `icon` field in the
+response, you need to set `CONST_MapIcon_URL` to the URL of the `/mapicon`
+directory of nominatim-ui.
+
 ### Change order during indexing
 
 When reindexing places during updates, there is now a different order used
diff --git a/docs/admin/Setup-Nominatim-UI.md b/docs/admin/Setup-Nominatim-UI.md
index 818ea408..9a6e163b 100644
--- a/docs/admin/Setup-Nominatim-UI.md
+++ b/docs/admin/Setup-Nominatim-UI.md
@@ -70,7 +70,7 @@ map $args $format {
 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.
-    ~/other$              0;   # An explicit non-html format paramter. No forwarding.
+    ~/other$              0;   # An explicit non-html format parameter. No forwarding.
     ~/reverse.*/default   0;   # Reverse and lookup assume xml format when
     ~/lookup.*/default    0;   #   no format parameter is given. No forwarding.
 }
@@ -87,14 +87,14 @@ rewrite ^/$ /search;
 location @php {
     # fastcgi stuff..
     if ($forward_to_ui) {
-        rewrite ^(/[^/]*) http://nominatim.loar/ui$1.html redirect;
+        rewrite ^(/[^/]*) https://yourserver.com/ui$1.html redirect;
     }
 }
 
 location ~ [^/]\.php(/|$) {
     # fastcgi stuff..
     if ($forward_to_ui) {
-        rewrite (.*).php http://nominatim.loar/ui$1.html redirect;
+        rewrite (.*).php https://yourserver.com/ui$1.html redirect;
     }
 }
 ```