Nginx for development mode

bd808 · bd808 · commit 04d274e287c1 · 2021-10-31T19:15:07.000-06:00
Add nginx to serve the generated static site and use that rather than
mkdocs' build in development mode server. This is being done because the
i18n plugin that we are going to be trying out does not work with the
dev server.
diff --git a/.dockerignore b/.dockerignore
@@ -9,6 +9,9 @@
 !.git/refs/heads/*
 !.pipeline
 !COPYING
+!contrib
+contrib/*
+!contrib/nginx
 !docs
 !poetry.lock
 !pyproject.toml
diff --git a/.pipeline/blubber.yaml b/.pipeline/blubber.yaml
@@ -45,3 +45,11 @@ variants:
       - from: local
         source: .
         destination: .
+
+  local:
+    # Local development container
+    includes:
+      - dev-python
+    apt:
+      packages:
+        - nginx-light
diff --git a/.pipeline/local.Dockerfile b/.pipeline/local.Dockerfile
@@ -1,10 +1,10 @@
 # Dockerfile for *local development*.
 # Generated by Blubber from .pipeline/blubber.yaml
-FROM docker-registry.wikimedia.org/python3-buster:latest AS dev-python
+FROM docker-registry.wikimedia.org/python3-buster:latest AS local
 USER 0
 ENV HOME="/root"
 ENV DEBIAN_FRONTEND="noninteractive"
-RUN apt-get update && apt-get install -y "gettext" "git" "python3-dev" "python3-venv" && rm -rf /var/lib/apt/lists/*
+RUN apt-get update && apt-get install -y "gettext" "git" "python3-dev" "python3-venv" "nginx-light" && rm -rf /var/lib/apt/lists/*
 RUN python3 "-m" "easy_install" "pip" && python3 "-m" "pip" "install" "-U" "setuptools" "wheel" "tox" "pip"
 ENV POETRY_VIRTUALENVS_PATH="/opt/lib/poetry"
 RUN python3 "-m" "pip" "install" "-U" "poetry==1.1.11"
@@ -19,4 +19,4 @@ RUN mkdir -p "/opt/lib/poetry"
 RUN poetry "install" "--no-root"
 COPY --chown=65533:65533 [".", "."]
 
-LABEL blubber.variant="dev-python" blubber.version="0.8.0+a6bf87e"
+LABEL blubber.variant="local" blubber.version="0.8.0+a6bf87e"
diff --git a/Makefile b/Makefile
@@ -20,7 +20,7 @@ this := $(word $(words $(MAKEFILE_LIST)),$(MAKEFILE_LIST))
 PROJECT_DIR := $(dir $(this))
 PIPELINE_DIR := $(PROJECT_DIR)/.pipeline
 BLUBBEROID := https://blubberoid.wikimedia.org
-DOCKERFILES := $(PIPELINE_DIR)/dev-python.Dockerfile
+DOCKERFILES := $(PIPELINE_DIR)/local.Dockerfile
 
 help:
 	@echo "Make targets:"
@@ -52,6 +52,11 @@ tail:  ## Tail logs from the docker-compose stack
 	docker compose logs -f
 .PHONY: tail
 
+build:  ## Build static site
+	docker compose exec portal \
+		poetry run mkdocs --verbose build
+.PHONY: tail
+
 clean:  ## Clean up Docker images and containers
 	yes | docker image prune
 	yes | docker container prune
diff --git a/contrib/nginx/nginx.conf b/contrib/nginx/nginx.conf
@@ -0,0 +1,39 @@
+daemon off;
+user runuser runuser;
+worker_processes auto;
+pid /tmp/nginx.pid;
+
+error_log /dev/stderr info;
+
+events {
+    worker_connections 768;
+}
+
+http {
+    include /etc/nginx/mime.types;
+    default_type application/octet-stream;
+    access_log /dev/stderr;
+
+    client_body_temp_path  "/tmp" 1 2;
+    proxy_temp_path        "/tmp" 1 2;
+    fastcgi_temp_path      "/tmp" 1 2;
+    scgi_temp_path         "/tmp" 1 2;
+    uwsgi_temp_path        "/tmp" 1 2;
+
+    sendfile on;
+    tcp_nopush on;
+    tcp_nodelay off;
+    gzip on;
+    keepalive_timeout 65;
+    types_hash_max_size 2048;
+    server_tokens off;
+
+
+
+    index index.html;
+
+    server {
+        listen 9000;
+        root /srv/app/site;
+    }
+}
diff --git a/docker-compose.yaml b/docker-compose.yaml
@@ -4,12 +4,16 @@ services:
   portal:
     build:
       context: .
-      dockerfile: .pipeline/dev-python.Dockerfile
-    image: "wmdevportal:dev-python"
+      dockerfile: .pipeline/local.Dockerfile
+    image: "wmdevportal:local"
     user: somebody
     working_dir: /srv/app
-    command: >
-      poetry run mkdocs serve --dev-addr 0.0.0.0:9000
+    command:
+      - bash
+      - -c
+      - >-
+        poetry run mkdocs --verbose build &&
+        exec nginx -c /srv/app/contrib/nginx/nginx.conf
     volumes:
       - type: bind
         source: .
