Merge pull request #12 from wisemen-digital/feature/env-based-config

ENV-based config

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/ /
+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
@@ -25,5 +25,5 @@ WORKDIR /var/www/html
 EXPOSE 8080
 
 # Start supervisord by default
-ENTRYPOINT ["/docker-entrypoint.sh"]
+ENTRYPOINT ["/scripts/docker-entrypoint.sh"]
 CMD ["serve"]

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

@@ -14,8 +14,14 @@ Docker will default to the `serve` command.
 - `init`: initialize the project, such as executing migrations.
 - fallback: execute the provided command.
 
+## Info
+
+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 |
@@ -38,10 +44,6 @@ This image can be configured using the following environment variables:
 | MATOMO_DATABASE_USER | Every run | Database user |
 | MATOMO_DATABASE_PASSWORD | Every run | Database password |
 
-## Info
-
-Serves content on port `8080`.
-
 # Initialization
 
 Using an init container (that invokes `init` command above), the container will be prepared for use. This entails:

matomo/Dockerfile

@@ -2,25 +2,21 @@
 
 set -euo pipefail
 
-
 ## Bootstrap
 
-
-if [ ! -e matomo.php ]; then
-  tar cf - --one-file-system -C /usr/src/matomo . | tar xf -
-fi
-
+for script in /scripts/startup/*.sh; do
+  $script
+done
 
 ## Commands ##
 
-
 # Helper to serve all services
 if [ "$1" = 'serve' ]; then
   exec /usr/bin/supervisord -c /etc/supervisor/supervisord.conf
 
 # Init script, for use in initContainers (for example)
 elif [ "$1" = 'init' ]; then 
-  exec /bootstrap.sh
+  exec /scripts/bootstrap.sh
 
 # Fallback: just execute given command
 else

matomo/README.md

@@ -0,0 +1,7 @@
+#!/usr/bin/env sh
+
+set -euo pipefail
+
+if [ ! -e matomo.php ]; then
+  tar cf - --one-file-system -C /usr/src/matomo . | tar xf -
+fi

matomo/scripts/docker-entrypoint.sh

@@ -20,16 +20,16 @@ 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/docker-entrypoint.sh /
+COPY common/scripts/ nuxt-base/scripts/ /scripts/
 
 # Clean Up
 WORKDIR /app/www
-RUN chown -R nobody:nobody /docker-entrypoint.sh /app/www /run /var/lib/nginx /var/log/nginx \
+RUN chown -R nobody:nobody /scripts /app/www /run /var/lib/nginx /var/log/nginx /etc/nginx/site-mods-enabled.d \
   && addgroup nobody tty
 EXPOSE 8080
 
 # Start supervisord by default
-ENTRYPOINT ["/docker-entrypoint.sh"]
+ENTRYPOINT ["/scripts/docker-entrypoint.sh"]
 CMD ["serve"]
 
 #

matomo/scripts/startup/unzip-matomo.sh

@@ -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.