Merge pull request #864 from DuendeSoftware/mb/staticredirects

Add Dockerfile to create container image

Author: maartenba

.dockerignore

@@ -0,0 +1,33 @@
+**/.dockerignore
+**/.env
+**/.git
+**/.gitignore
+**/.project
+**/.settings
+**/.toolstarget
+**/.vs
+**/.vscode
+**/.idea
+**/*.*proj.user
+**/*.dbmdl
+**/*.jfm
+**/azds.yaml
+**/bin
+**/node_modules
+**/npm-debug.log
+**/obj
+**/secrets.dev.yaml
+**/values.dev.yaml
+
+**/.devcontainer
+**/.fleet
+**/.husky
+**/.run
+**/.space
+**/dist
+docker-compose*.yml
+Dockerfile*
+LICENSE
+LICENSE-CODE
+README.md
+redirect.conf

Dockerfile

@@ -0,0 +1,33 @@
+FROM node:22-alpine AS builder
+
+EXPOSE 8080
+
+WORKDIR /app
+COPY package.json package-lock.json ./
+RUN npm install --no-cache
+COPY . .
+RUN chmod +x build.sh
+
+RUN ./build.sh
+
+FROM nginx:stable-alpine AS final
+
+ARG APPLICATION_VERSION
+COPY deployment/nginx.conf /etc/nginx/nginx.conf
+COPY deployment/default.conf /etc/nginx/conf.d/default.conf
+RUN sed -i "s|\$APPLICATION_VERSION|${APPLICATION_VERSION}|g" /etc/nginx/conf.d/default.conf
+COPY --from=builder --chown=nginx:nginx /app/root/redirect.conf /etc/nginx/extra/redirect.conf
+
+RUN rm -rf /usr/share/nginx/html/*
+COPY --from=builder --chown=nginx:nginx /app/root/ /usr/share/nginx/html/
+RUN rm -rf /usr/share/nginx/html/redirect.conf
+
+RUN mkdir -p /var/cache/nginx
+
+RUN chown -R nginx:nginx /var/cache/nginx
+RUN touch /var/run/nginx.pid && \
+        chown -R nginx:nginx /var/run/nginx.pid
+
+USER nginx
+
+WORKDIR /usr/share/nginx/html

astro.config.mjs

@@ -16,6 +16,7 @@ import * as fs from "node:fs";
 // https://github.com/withastro/astro/issues/9782
 import { duendeOpenGraphImage } from "./src/plugins/duende-og-image.js";
 import removeMarkdownExtensions from "./src/plugins/remove-markdown-extensions.js";
+import staticRedirects from "./src/plugins/static-redirects.js";
 
 // https://astro.build/config
 export default defineConfig({
@@ -218,6 +219,7 @@ export default defineConfig({
     redirectFrom({
       contentDir: "./src/content/docs",
     }),
+    staticRedirects(),
     opengraphImages({
       options: {
         fonts: [

build.sh

@@ -1,3 +1,4 @@
+#!/bin/sh
 set -e
 
 npm install

deployment/default.conf

@@ -0,0 +1,21 @@
+server {
+    listen       8080;
+    listen  [::]:8080;
+    server_name  localhost;
+    location / {
+        root   /usr/share/nginx/html;
+        index  index.html index.htm;
+        add_header X-REVISION $APPLICATION_VERSION;
+    }
+    include /etc/nginx/extra/*.conf;
+
+    error_page 404 /404.html;
+    location = /404.html {
+        root   /usr/share/nginx/html;
+    }
+
+    error_page   500 502 503 504  /50x.html;
+    location = /50x.html {
+        root   /usr/share/nginx/html;
+    }
+}

deployment/nginx.conf

@@ -0,0 +1,31 @@
+user  nginx;
+worker_processes  auto;
+
+error_log  /var/log/nginx/error.log notice;
+pid        /var/run/nginx.pid;
+
+
+events {
+    worker_connections  1024;
+}
+
+
+http {
+    include       /etc/nginx/mime.types;
+    default_type  application/octet-stream;
+
+    log_format  main  '$remote_addr - $remote_user [$time_local] "$request" '
+                      '$status $body_bytes_sent "$http_referer" '
+                      '"$http_user_agent" "$http_x_forwarded_for"';
+
+    access_log  /var/log/nginx/access.log  main;
+
+    sendfile        on;
+    #tcp_nopush     on;
+
+    keepalive_timeout  65;
+
+    gzip  on;
+
+    include /etc/nginx/conf.d/*.conf;
+}

src/plugins/static-redirects.ts

@@ -0,0 +1,84 @@
+import url from "node:url";
+import type { AstroConfig, AstroIntegrationLogger } from "astro";
+import path from "node:path";
+import fs from "node:fs/promises";
+
+function createNginxRule(redirectFrom: string, redirectTo: string) {
+  if (redirectFrom.endsWith("/")) {
+    redirectFrom = redirectFrom.slice(0, -1);
+  }
+
+  return (
+    "rewrite ^" +
+    redirectFrom +
+    "(/?)$ $scheme://$http_host" +
+    redirectTo +
+    "/ permanent;\n"
+  );
+}
+
+let nginxRedirectRules = "";
+
+export async function configurePlugin(hookOptions: any) {
+  const buildOutput: string = hookOptions.buildOutput;
+  const config: AstroConfig = hookOptions.config;
+  const logger: AstroIntegrationLogger = hookOptions.logger;
+
+  if (buildOutput !== "static") {
+    logger.warn(
+      `Skip generating static redirects: not compatible with '${buildOutput}' builds, only 'static' is supported.`,
+    );
+    return;
+  }
+
+  // Find redirects
+  const redirects = config.redirects;
+  if (!Object.keys(redirects).length) {
+    logger.warn("Skip generating static redirects: no redirects found.");
+    return;
+  }
+
+  // Add redirects
+  logger.info("Generating static redirects file...");
+  Object.keys(redirects).forEach((from) => {
+    const redirect = redirects[from];
+
+    if (typeof redirect === "string") {
+      nginxRedirectRules += createNginxRule(from, redirect);
+    } else {
+      nginxRedirectRules += createNginxRule(from, redirect.destination);
+    }
+  });
+}
+
+export async function writeToOutput(hookOptions: any) {
+  const outDir: string = hookOptions.dir;
+  const logger: AstroIntegrationLogger = hookOptions.logger;
+
+  if (!nginxRedirectRules || !nginxRedirectRules.length) {
+    logger.warn(
+      `Skip generating static redirects file: no redirects were generated.`,
+    );
+    return;
+  }
+
+  // Write redirect.conf
+  const configDestinationPath = path.join(
+    url.fileURLToPath(outDir),
+    "redirect.conf",
+  );
+  await fs.writeFile(configDestinationPath, nginxRedirectRules);
+  logger.info(`Generated static redirects file: ${configDestinationPath}`);
+}
+
+export default function staticRedirects() {
+  return {
+    name: "static-redirects",
+    hooks: {
+      "astro:config:done": async (hookOptions: any) =>
+        await configurePlugin(hookOptions),
+      "astro:build:done": async (hookOptions: any) =>
+        await writeToOutput(hookOptions),
+    },
+  };
+}