Add payload image

Author: djbe

.github/workflows/build-and-publish-payload-base.yml

@@ -0,0 +1,29 @@
+---
+name: Build & Publish Payload Base
+
+on:  # yamllint disable-line rule:truthy
+  schedule:
+    - cron: "0 0 1,15 * *"  # Every 2 weeks
+  push:
+    branches:
+      - main
+    paths:
+      - .github/workflows/build-and-publish-payload-base.yml
+      - .github/workflows/internal-build-and-publish.yml
+      - 'common/**'
+      - 'payload-base/**'
+  workflow_dispatch:
+
+jobs:
+  build-and-publish:
+    uses: ./.github/workflows/internal-build-and-publish.yml
+    strategy:
+      matrix:
+        info:
+          - version: lts
+            node: lts
+    with:
+      image: payload-base
+      version: ${{ matrix.info.version }}
+      build-args: |
+        NODE_VERSION=${{ matrix.info.node }}

payload-base/Dockerfile

@@ -0,0 +1,46 @@
+#
+# --- Stage 1: Base ---
+#
+
+ARG NODE_VERSION=lts
+FROM node:${NODE_VERSION}-alpine AS base
+
+# Install packages
+# hadolint ignore=DL3018
+RUN apk add --no-cache \
+    nginx \
+    supervisor
+
+# Copy configuration files
+# - nginx
+COPY common/config/nginx/ /etc/nginx/
+COPY payload-base/config/nginx/http.d/ /etc/nginx/http.d/
+# - supervisor
+COPY common/config/supervisor/supervisord.conf /etc/supervisor/
+COPY common/config/supervisor/conf.d/nginx.conf /etc/supervisor/conf.d/
+COPY payload-base/config/supervisor/conf.d/ /etc/supervisor/conf.d/
+# - init
+COPY common/scripts/ payload-base/scripts/ /scripts/
+
+# Clean Up
+WORKDIR /app/www
+RUN chown -R nobody:nobody \
+    /app/www \
+    /etc/nginx/site-mods-enabled.d \
+    /run \
+    /var/lib/nginx \
+    /var/log/nginx \
+  && addgroup nobody tty
+EXPOSE 8080
+
+# Start supervisord by default
+ENTRYPOINT ["/scripts/docker-entrypoint.sh"]
+CMD ["serve"]
+
+#
+# --- Variant: Default ---
+#
+
+FROM base AS final
+
+USER nobody

payload-base/README.md

@@ -0,0 +1,22 @@
+# Base Payload Docker
+
+🐳 Generic docker image for Payload Applications.
+
+Available images:
+- `lts`: normal version.
+
+## Commands
+
+Docker will default to the `serve` command.
+
+- `serve`: starts all services, such as `nginx`.
+- `node`: helper to execute node commands.
+- fallback: execute the provided command.
+
+## Info
+
+Serves content on port `8080`.
+
+## Configuration
+
+Check the [general readme](../README.md) for configuring common settings.

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

@@ -0,0 +1,30 @@
+server {
+  listen 8080 default_server;
+  listen [::]:8080 default_server;
+  server_name _;
+
+  # Root path
+  set $root /app/www/public;
+  if (!-d /app/www/public) {
+    set $root /app/www;
+  }
+  root $root;
+
+  # Apply cors
+  include /etc/nginx/snippets/headers/cors.conf;
+
+  # Serve files (and nice URLs)
+  location / {
+    try_files $uri $uri/index.html $uri.html @backend;
+  }
+
+  # Serve Node
+  location @backend {
+    include /etc/nginx/snippets/proxy/config.conf;
+    include /etc/nginx/snippets/proxy/avoid-double-headers.conf;
+    proxy_pass http://127.0.0.1:3000;
+  }
+
+  # Load site mods
+  include /etc/nginx/site-mods-enabled.d/*.conf;
+}

payload-base/config/supervisor/conf.d/payload.conf

@@ -0,0 +1,12 @@
+[program:payload]
+command=sh -c "node ./server.js || kill -s SIGQUIT $PPID"
+directory=%(ENV_CURRENT_WORKING_DIRECTORY)s
+
+stdout_logfile=/dev/stdout
+stdout_logfile_maxbytes=0
+stderr_logfile=/dev/stderr
+stderr_logfile_maxbytes=0
+
+autorestart=false
+startretries=0
+stopasgroup=true

payload-base/scripts/docker-entrypoint.sh

@@ -0,0 +1,33 @@
+#!/usr/bin/env sh
+
+set -euo pipefail
+
+## Bootstrap
+
+for script in /scripts/startup/*.sh; do
+  $script
+done
+
+## Commands ##
+
+# Helper to serve all services
+if [ "$1" = 'serve' ]; then
+  export CURRENT_WORKING_DIRECTORY=$(pwd)
+  export HOSTNAME=0.0.0.0 PORT=3000
+  exec /usr/bin/supervisord -c /etc/supervisor/supervisord.conf
+
+# Helper to run workers
+elif [ "$1" = 'worker' ]; then 
+  shift 1;
+  export IS_JOB=TRUE
+  exec /usr/local/bin/node ./server.js "$@"
+
+# Helper to run node commands
+elif [ "$1" = 'node' ]; then
+  shift 1;
+  exec /usr/local/bin/node "$@"
+
+# Fallback: just execute given command
+else
+  exec "$@"
+fi

payload-base/scripts/startup/50-move-static-files.sh

@@ -0,0 +1,24 @@
+#!/usr/bin/env sh
+
+set -euo pipefail
+
+# Move static files, so we can serve `/_next/static/…`
+if [ -d "/app/www/.next/static" ]; then
+  if [ -d "/app/www/public" ]; then
+    # Nginx root will be /app/www/public if it exists
+    mv /app/www/.next /app/www/public/_next
+
+    # LEGACY: ensure `npm start` still works
+    if [ -d "./.next" ]; then
+      ln -s /app/www/public/_next/static ./.next/static
+    fi
+  else
+    # Otherwise it'll just be /app/www
+    mv /app/www/.next /app/www/_next
+
+    # LEGACY: add alias for `npm start`
+    if [ -d "./.next" ]; then
+      ln -s /app/www/_next/static ./.next/static
+    fi
+  fi
+fi