feat: add nginx proxy in own docker-compose file

Includes a Makefile rule to run it, and some documentation in README.md. Also
adds a markdownlint silencer and one or two touchups to the whitespace.

Author: gadomski

Makefile

@@ -30,6 +30,10 @@ docker-run-sqlalchemy: image
 docker-run-pgstac: image
 	$(run_pgstac)
 
+.PHONY: docker-run-nginx-proxy
+docker-run-nginx-proxy:
+	docker-compose -f docker-compose.yml -f docker-compose.nginx.yml up
+
 .PHONY: docker-shell-sqlalchemy
 docker-shell-sqlalchemy:
 	$(run_sqlalchemy) /bin/bash

README.md

@@ -1,3 +1,5 @@
+<!-- markdownlint-disable MD033 MD041 -->
+
 <p align="center">
   <img src="https://github.com/radiantearth/stac-site/raw/master/images/logo/stac-030-long.png" width=400>
   <p align="center">FastAPI implemention of the STAC API spec.</p>
@@ -30,6 +32,7 @@ packages:
 - **stac_fastapi.types**: Shared types and abstract base classes used by the library.
 
 #### Backends
+
 - **stac_fastapi.sqlalchemy**: Postgres backend implementation with sqlalchemy.
 - **stac_fastapi.pgstac**: Postgres backend implementation with [PGStac](https://github.com/stac-utils/pgstac).
 
@@ -64,6 +67,7 @@ pip install -e stac_fastapi/pgstac
 ## Local Development
 
 Use docker-compose via make to start the application, migrate the database, and ingest some example data:
+
 ```bash
 make image
 make docker-run-all
@@ -84,7 +88,23 @@ The application will be started on <http://localhost:8080>.
 By default, the apps are run with uvicorn hot-reloading enabled. This can be turned off by changing the value
 of the `RELOAD` env var in docker-compose.yml to `false`.
 
-#### Note to Docker for Windows users
+### nginx proxy
+
+This repo includes an example nginx proxy service.
+To start:
+
+```shell
+make docker-run-nginx-proxy
+```
+
+The proxy will be started on <http://localhost>, with the pgstac app available at <http://localhost/api/v1/pgstac/> and the sqlalchemy app at <http://localhost/api/v1/sqlalchemy/>.
+If you need to customize the proxy port, use the `STAC_FASTAPI_NGINX_PORT` environment variable:
+
+```shell
+STAC_FASTAPI_NGINX_PORT=7822 make docker-run-nginx-proxy
+```
+
+### Note to Docker for Windows users
 
 You'll need to enable experimental features on Docker for Windows in order to run the docker-compose,
 due to the "--platform" flag that is required to allow the project to run on some Apple architectures.

docker-compose.nginx.yml

@@ -0,0 +1,18 @@
+version: '3'
+services:
+  nginx:
+    image: nginx
+    ports:
+      - ${STAC_FASTAPI_NGINX_PORT:-80}:80
+    volumes:
+      - ./nginx.conf:/etc/nginx/nginx.conf
+    depends_on:
+      - app-pgstac
+      - app-sqlalchemy
+    command: [ "nginx-debug", "-g", "daemon off;" ]
+  app-pgstac:
+    environment:
+      - UVICORN_ROOT_PATH=/api/v1/pgstac
+  app-sqlalchemy:
+    environment:
+      - UVICORN_ROOT_PATH=/api/v1/sqlalchemy

docker-compose.yml

@@ -1,16 +1,5 @@
 version: '3'
 services:
-  nginx:
-    image: nginx
-    ports:
-      - ${STAC_FASTAPI_NGINX_PORT:-80}:80
-    volumes:
-      - ./nginx.conf:/etc/nginx/nginx.conf
-    depends_on:
-      - app-pgstac
-      - app-sqlalchemy
-    command: ["nginx-debug", "-g", "daemon off;"]
-
   app-sqlalchemy:
     container_name: stac-fastapi-sqlalchemy
     image: stac-utils/stac-fastapi
@@ -30,7 +19,6 @@ services:
       - POSTGRES_HOST_WRITER=database
       - POSTGRES_PORT=5432
       - WEB_CONCURRENCY=10
-      - UVICORN_ROOT_PATH=/api/v1/sqlalchemy
     ports:
       - "8081:8081"
     volumes:
@@ -62,7 +50,6 @@ services:
       - DB_MIN_CONN_SIZE=1
       - DB_MAX_CONN_SIZE=1
       - USE_API_HYDRATE=${USE_API_HYDRATE:-false}
-      - UVICORN_ROOT_PATH=/api/v1/pgstac
     ports:
       - "8082:8082"
     volumes: