Nginx: rework robots config to use ENV vars

Author: djbe

README.md

@@ -5,3 +5,16 @@ This is a collection of Docker images, both for development purposes, use during
 # Development
 
 Changes to this repository will trigger a build and push to GitHub packages automatically.
+
+# Configuration
+
+## nginx
+
+Images with `nginx` can be configured using the following environment variables.
+
+### Robots
+
+| Environment Key | Applied | Description | Default |
+------------------|---------|------------------------
+| NGINX_ROBOTS_TAG | Every run | `X-Robots-Tag` value | `none` |
+| NGINX_ROBOTS_TXT | Every run | Content of `robots.txt` | `Disallow: /` |

common/config/nginx/site-mods-available.d/no-robots.conf

@@ -0,0 +1,32 @@
+#!/usr/bin/env sh
+
+set -euo pipefail
+
+# Configure nginx robots rules based on ENV vars
+#
+# Inputs:
+# - NGINX_ROBOTS_TAG: defaults to 'none'
+# - NGINX_ROBOTS_TXT: defaults to 'Disallow: /'
+
+# Set defaults
+NGINX_ROBOTS_TAG="${NGINX_ROBOTS_TAG:-none}"
+NGINX_ROBOTS_TXT="${NGINX_ROBOTS_TXT:-Disallow: /}"
+
+if [ -d /etc/nginx/site-mods-enabled.d/ ]; then
+  # robots tag header
+  echo "Nginx: configuring robots tag header with '${NGINX_ROBOTS_TAG}'…"
+  cat <<EOF > /etc/nginx/site-mods-enabled.d/generated-robots.conf
+# Configure indexing
+add_header 'X-Robots-Tag' '${NGINX_ROBOTS_TAG}';
+EOF
+
+  # robots.txt file
+  echo "Nginx: configuring robots.txt with '${NGINX_ROBOTS_TXT}'…"
+  cat <<EOF >> /etc/nginx/site-mods-enabled.d/generated-robots.conf
+# Configure crawlers
+location = /robots.txt {
+  add_header 'Content-Type' 'text/plain';
+  return 200 "User-agent: *\n${NGINX_ROBOTS_TXT}\n";
+}
+EOF
+fi

common/config/nginx/site-mods-enabled.d/no-robots.conf

@@ -15,7 +15,7 @@ COPY common/config/supervisor/supervisord.conf /etc/supervisor/
 COPY common/config/supervisor/conf.d/nginx.conf /etc/supervisor/conf.d/
 COPY matomo/config/supervisor/conf.d/ /etc/supervisor/conf.d/
 # - init
-COPY matomo/scripts/ /scripts/
+COPY common/scripts/ matomo/scripts/ /scripts/
 
 # Configure cron
 RUN echo "*/30 * * * * /usr/local/bin/php /var/www/html/console core:archive --verbose --no-interaction" > /etc/crontabs/www-data

common/scripts/startup/env-configure-robots.sh

@@ -20,6 +20,8 @@ Serves content on port `8080`.
 
 ## Configuration
 
+Check the [general readme](../README.md) for configuring common settings.
+
 This image can be configured using the following environment variables:
 
 | Environment Key | Applied | Description |

matomo/Dockerfile

@@ -20,7 +20,7 @@ COPY common/config/supervisor/supervisord.conf /etc/supervisor/
 COPY common/config/supervisor/conf.d/nginx.conf /etc/supervisor/conf.d/
 COPY nuxt-base/config/supervisor/conf.d/ /etc/supervisor/conf.d/
 # - init
-COPY nuxt-base/scripts/ /scripts/
+COPY common/scripts/ nuxt-base/scripts/ /scripts/
 
 # Clean Up
 WORKDIR /app/www

matomo/README.md

@@ -16,3 +16,7 @@ Docker will default to the `serve` command.
 ## Info
 
 Serves content on port `8080`.
+
+## Configuration
+
+Check the [general readme](../README.md) for configuring common settings.

nuxt-base/Dockerfile

@@ -55,7 +55,7 @@ COPY php-base/config/php/ /etc/php${PHP_VERSION}/
 COPY common/config/supervisor/supervisord.conf /etc/supervisor/
 COPY common/config/supervisor/conf.d/nginx.conf /etc/supervisor/conf.d/
 # - init
-COPY php-base/scripts/ /scripts/
+COPY common/scripts/ php-base/scripts/ /scripts/
 
 # Clean Up
 WORKDIR /app/www

nuxt-base/README.md

@@ -25,6 +25,8 @@ Serves content on port `8080`.
 
 ## Configuration
 
+Check the [general readme](../README.md) for configuring common settings.
+
 This image can be configured using the following environment variables:
 
 | Environment Key | Applied | Description | Default |