v3.4, new Python API, removed PHP

Author: dsperling

README.md

@@ -8,7 +8,7 @@ n7m is Nominatim packaged in Docker images with separation of responsibilities b
 
 ## Overview
 This set of Docker images seperates responsbility into 5 areas:
-* **n7m-app** - The main Nomainatim service running PHP-FPM connecting to `n7m-gis`
+* **n7m-app** - The main Nomainatim service running uvicorn connecting to `n7m-gis`
   * **feed** - Uses the `n7m-app` image to set up the `n7m-gis` database.  Can also be used for updates and downloading files.
 * **n7m-gis** - Postgis database 
 * **n7m-ui** - Test web user interface

app/Dockerfile

@@ -19,11 +19,12 @@ RUN apt-get update && apt-get install -y --no-install-recommends \
     liblua5.4-dev \
     libpq-dev \
     libproj-dev \
+    nlohmann-json3-dev \
     php \
     python3 \
     zlib1g-dev
 
-ENV NOMINATIM_VERSION=4.2.3
+ENV NOMINATIM_VERSION=4.3.2
 
 # Fetch
 WORKDIR /nominatim
@@ -48,20 +49,18 @@ RUN apt-get update && apt-get install -y --no-install-recommends \
     curl \
     liblua5.4 \
     libproj-dev \
-    php \
-    php-fpm \
-    php-pgsql \
-    php-intl \
     postgresql-client-14 \
     python3-asyncpg \
     python3-datrie \
     python3-dotenv \
+    python3-falcon \
     python3-geoalchemy2 \
     python3-icu \
     python3-jinja2 \
     python3-psutil \
     python3-psycopg2 \
     python3-pyosmium \
+    python3-uvicorn \
     python3-sqlalchemy \
     python3-yaml \
  && apt-get clean \
@@ -73,7 +72,7 @@ ENV NOMINATIM_TOKENIZER=icu \
     PGUSER=postgres \
     PGPASSWORD=change-this-password \
     OSM_FILENAME= \
-    FPM_CONFIG=/etc/php/8.1/fpm/pool.d/www.conf
+    WEB_CONCURRENCY=1
 
 WORKDIR /nominatim
 
@@ -86,13 +85,7 @@ COPY --from=build /usr/local/share/nominatim/ /usr/local/share/nominatim/
 # copy shell scripts
 COPY --chmod=0755 *.sh ./
 
-# fpm settings required for Docker
-RUN sed -i '1 i\[global]\nerror_log = /proc/self/fd/2\n' $FPM_CONFIG \
- && sed -i 's|;access.log = log/$pool.access.log|access.log = /proc/self/fd/2|' $FPM_CONFIG \
- && sed -i 's|listen = /run/php/php8.1-fpm.sock|listen = 9000|' $FPM_CONFIG \
- && ln -s /usr/sbin/php-fpm8.1 /usr/sbin/php-fpm
-
 ENTRYPOINT [ "./entrypoint.sh" ]
-CMD [ "fpm" ]
+CMD [ "uvicorn" ]
 
-EXPOSE 9000
+EXPOSE 8000

app/entrypoint.sh

@@ -109,14 +109,17 @@ if [ "$1" = 'replication' ]; then
   exec nominatim "$@" --threads $PROCESSING_UNITS
 fi
 
-# php-fpm
-if [ "$1" = 'fpm' ]; then
+# uvicorn ASGI
+if [ "$1" = 'uvicorn' ]; then
   waitForGis
   waitForGisDatabase nominatim
-  nominatim refresh --website --functions
 
-  # run in the foreground
-  exec php-fpm --nodaemonize
+  # the new server code is bundled within the python library
+  cd /usr/local/lib/nominatim/lib-python
+  # uvicorn uses the WEB_CONCURRENCY env variable for multiple worker processes
+  # modify WEB_CONCURRENCY in docker-compose.yaml
+  exec python3 -m uvicorn nominatim.server.falcon.server:run_wsgi \
+    --proxy-headers --host 0.0.0.0 --port 8000 --factory
 fi
 
 exec "$@"

deploy/docker-compose-setup.yml

@@ -2,7 +2,7 @@ version: '2'
 
 services:
   feed:
-    image: smithmicro/n7m-app:4.2
+    image: smithmicro/n7m-app:4.3
     depends_on:
       - gis
     environment:

deploy/docker-compose.yml

@@ -2,7 +2,7 @@ version: '2'
 
 services:
   web:
-    image: smithmicro/n7m-web:4.2
+    image: smithmicro/n7m-web:4.3
     restart: always
     ports:
       - "80:80"
@@ -11,16 +11,17 @@ services:
       - ui
     mem_limit: 100m
   ui:
-    image: smithmicro/n7m-ui:3.2
+    image: smithmicro/n7m-ui:3.4
     restart: always
     mem_limit: 100m
   app:
-    image: smithmicro/n7m-app:4.2
+    image: smithmicro/n7m-app:4.3
     restart: always
     depends_on:
       - gis
     environment:
       - PGPASSWORD=n7m-geocoding
+      - WEB_CONCURRENCY=4
   gis:
     image: postgis/postgis:15-3.3-alpine
     restart: always

docker-compose.yml

@@ -3,7 +3,7 @@ version: '2'
 services:
   web:
     build: web
-    image: smithmicro/n7m-web:4.2
+    image: smithmicro/n7m-web:4.3
     restart: always
     ports:
       - "8080:80"
@@ -13,20 +13,21 @@ services:
     mem_limit: 100m
   ui:
     build: ui
-    image: smithmicro/n7m-ui:3.2
+    image: smithmicro/n7m-ui:3.4
     restart: always
     mem_limit: 100m
   app:
     build: app
-    image: smithmicro/n7m-app:4.2
+    image: smithmicro/n7m-app:4.3
     #restart: always
     environment:
       - PGPASSWORD=n7m-geocoding
+      - WEB_CONCURRENCY=2
     depends_on:
       - gis
     mem_limit: 200m
   feed:
-    image: smithmicro/n7m-app:4.2
+    image: smithmicro/n7m-app:4.3
     depends_on:
       - gis
     environment:

ui/Dockerfile

@@ -2,7 +2,7 @@ FROM nginx:1.24-alpine
 
 # https://nominatim.org/release-docs/latest/admin/Setup-Nominatim-UI/
 
-ENV NOMINATIM_UI_VERSION=3.2.12
+ENV NOMINATIM_UI_VERSION=3.4.0
 ENV NOMINATIM_UI_FILENAME=nominatim-ui-$NOMINATIM_UI_VERSION
 ENV NOMINATIM_APINOMINATIM_API_ENDPOINT_URI=/api/v4/
 ENV NGINX_HTML_PATH=/usr/share/nginx/html

web/site.conf

@@ -7,31 +7,39 @@ server {
     # error_log /var/log/nginx/error.log debug;
     # command: [nginx-debug, '-g', 'daemon off;']
 
-    # n7m-app - exposing reverse geocoding without an extension
-    location /api/v4/reverse {
-        root /nominatim/website;
-        fastcgi_param SCRIPT_FILENAME "$document_root/reverse.php";
-        fastcgi_pass app:9000;
-        include fastcgi_params;
-    }
-    # n7m-app - PHP endpoints
+    # n7m-app - Python endpoint
     location /api/v4/ {
-        root /nominatim/website;
-        fastcgi_split_path_info ^/api/v4(/.+\.php)()$;
-        fastcgi_param SCRIPT_FILENAME "$document_root$fastcgi_script_name";
-        fastcgi_pass app:9000;
-        include fastcgi_params;
+        rewrite /api/v4/(.*) /$1  break;
+        proxy_set_header Host $http_host;
+        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+        proxy_set_header X-Forwarded-Proto $scheme;
+        proxy_set_header Upgrade $http_upgrade;
+        proxy_set_header Connection $connection_upgrade;
+        proxy_redirect off;
+        proxy_buffering off;
+        proxy_pass http://app:8000;
     }
-    # n7m-app - health endponnt
+
+    # n7m-app - Python health endpoint
     location /health {
-        root /nominatim/website;
-        fastcgi_param SCRIPT_FILENAME "$document_root/status.php";
-        fastcgi_pass app:9000;
-        include fastcgi_params;
+        rewrite /health /status.php  break;
+        proxy_set_header Host $http_host;
+        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+        proxy_set_header X-Forwarded-Proto $scheme;
+        proxy_set_header Upgrade $http_upgrade;
+        proxy_set_header Connection $connection_upgrade;
+        proxy_redirect off;
+        proxy_buffering off;
+        proxy_pass http://app:8000;
     }
 
     # n7m-ui
     location / {
         proxy_pass http://ui;
     }
 }
+
+map $http_upgrade $connection_upgrade {
+    default upgrade;
+    '' close;
+}