Merge branch 'feature/dynamic-api-paths'

Author: djbe

README.md

@@ -18,6 +18,12 @@ Images with `nginx` can be configured using the following environment variables.
 |-----------------|---------|-------------|---------|
 | NGINX_CORS_ORIGINS | Every run | Comma separated list of hostnames (without `https://`) | `*` |
 
+### Paths
+
+| Environment Key | Applied | Description | Default |
+|-----------------|---------|-------------|---------|
+| NGINX_API_PATHS | Every run | Comma separated list of paths (without `/`), pointed to the `@api_backend` bucket. Note to only use this on images that have such a backend. | |
+
 ### Robots
 
 | Environment Key | Applied | Description | Default |

common/scripts/startup/50-env-configure-nginx-api-paths.sh

@@ -0,0 +1,25 @@
+#!/usr/bin/env sh
+
+set -euo pipefail
+
+# Configure nginx CORS rules based on ENV vars
+#
+# Inputs:
+# - NGINX_API_PATHS: defaults to '' (empty list)
+
+# Set defaults & clean up (normalize, trim, …)
+NGINX_CONFIG_FILE=/etc/nginx/site-mods-enabled.d/generated-api-paths.conf
+NGINX_API_PATHS=$(echo "${NGINX_API_PATHS:-}" \
+  | sed 's/,/ /g; s/^ *//; s/ *$//; s/  */ /g')
+
+# Check nginx structure
+if [ ! -d /etc/nginx/site-mods-enabled.d/ ]; then
+  exit 0
+fi
+
+# Generate location blocks
+echo "Nginx: configuring API paths with '${NGINX_API_PATHS}'…"
+echo "# Point API paths to API bucket" > "${NGINX_CONFIG_FILE}"
+for item in $NGINX_API_PATHS; do
+  echo "location ~ ^/${item}/ { try_files \$uri @api_backend; }" >> "${NGINX_CONFIG_FILE}"
+done

nuxt-base/Dockerfile

@@ -19,6 +19,9 @@ COPY config/s6-overlay /etc/s6-overlay/s6-rc.d/
 # - init
 COPY scripts/ /scripts/
 
+# Defaults
+ENV NGINX_API_PATHS=api
+
 #
 # --- Variant: Unsecured ---
 #

nuxt-base/config/nginx/http.d/default.conf

@@ -11,9 +11,7 @@ server {
   root $root;
 
   # Serve files (and nice URLs)
-  location ~ ^/api/ {
-    try_files $uri @api_backend;
-  }
+  # Note: API location generated by script using `NGINX_API_PATHS`
   location / {
     try_files $uri $uri/index.html $uri.html @web_backend;
   }

payload-base/Dockerfile

@@ -19,6 +19,9 @@ COPY config/s6-overlay /etc/s6-overlay/s6-rc.d/
 # - init
 COPY scripts/ /scripts/
 
+# Defaults
+ENV NGINX_API_PATHS=api
+
 #
 # --- Variant: Default ---
 #

payload-base/config/nginx/http.d/default.conf

@@ -11,9 +11,7 @@ server {
   root $root;
 
   # Serve files (and nice URLs)
-  location ~ ^/api/ {
-    try_files $uri @api_backend;
-  }
+  # Note: API location generated by script using `NGINX_API_PATHS`
   location / {
     try_files $uri $uri/index.html $uri.html @web_backend;
   }

php-base/Dockerfile

@@ -52,6 +52,9 @@ COPY config/s6-overlay /etc/s6-overlay/s6-rc.d/
 # - init
 COPY scripts/ /scripts/
 
+# Defaults
+ENV NGINX_API_PATHS=api,oauth,livewire
+
 #
 # --- Variant: Octane ---
 #

php-base/config/nginx/http.d/default-fpm.conf

@@ -13,9 +13,7 @@ server {
   root $root;
 
   # Serve files (and nice URLs)
-  location ~ ^/(api|oauth|livewire)/ {
-    try_files $uri @api_backend;
-  }
+  # Note: API location generated by script using `NGINX_API_PATHS`
   location / {
     try_files $uri @web_backend;
   }

php-base/config/nginx/http.d/default-octane.conf

@@ -13,9 +13,7 @@ server {
   root $root;
 
   # Serve files (and nice URLs)
-  location ~ ^/(api|oauth|livewire)/ {
-    try_files $uri @api_backend;
-  }
+  # Note: API location generated by script using `NGINX_API_PATHS`
   location / {
     try_files $uri @web_backend;
   }

tests/nuxt-base/secure/api-paths/env.properties

@@ -0,0 +1 @@
+NGINX_API_PATHS=api,custom-api