Changeset 63308

Timestamp:

08/16/2026 06:46:59 PM (5 hours ago)

Author:

westonruter

Message:

Build/Test Tools: Allow text compression in the local environment.

Add gzip directives to the nginx config template used by the local Docker environment so that HTML, JavaScript, CSS, JSON, XML, and SVG responses can be served compressed, matching normal production behavior. Without compression, frontend performance analysis against the local environment is not representative of a real user's experience.

Compression is controlled by a new LOCAL_NGINX_COMPRESSION option, and it defaults to off so that it is opt-in.

Since this changes docker-compose.yml in addition to the nginx template, existing checkouts need to recreate the web server container to pick up the change.

Developed in ​https://github.com/WordPress/wordpress-develop/pull/12529.
Follow-up to r45745, r45783.

Props westonruter, jblz.
Fixes #65634.

Location:

trunk

Files:

• .env.example (modified) (1 diff)
• docker-compose.yml (modified) (2 diffs)
• tools/local-env/default.template (modified) (1 diff)

trunk/.env.example

@@ -14 +14 @@
 # Where to run WordPress from. Valid options are 'src' and 'build'.
 LOCAL_DIR=src
+
+# Whether or not to enable text compression (gzip) in the web server.
+# Valid options are 'on' and 'off'.
+LOCAL_NGINX_COMPRESSION=off
 
 # The PHP version to use. Valid options are 'latest', and '{version}-fpm'.

trunk/docker-compose.yml

@@ -15 +15 @@
     environment:
       LOCAL_DIR: ${LOCAL_DIR-src}
+      LOCAL_NGINX_COMPRESSION: ${LOCAL_NGINX_COMPRESSION:-off}
 
     volumes:
@@ -21 +22 @@
 
     # Load our config file, substituting environment variables into the config.
-    command: /bin/sh -c "envsubst '$$LOCAL_DIR' < /etc/nginx/conf.d/default.template > /etc/nginx/conf.d/default.conf && exec nginx -g 'daemon off;'"
+    command: /bin/sh -c "envsubst '$$LOCAL_DIR $$LOCAL_NGINX_COMPRESSION' < /etc/nginx/conf.d/default.template > /etc/nginx/conf.d/default.conf && exec nginx -g 'daemon off;'"
 
     depends_on:

trunk/tools/local-env/default.template

@@ -15 +15 @@
 
         absolute_redirect off;
+
+        gzip ${LOCAL_NGINX_COMPRESSION};
+        gzip_vary on;
+        gzip_proxied any;
+        gzip_comp_level 5;
+        gzip_min_length 256;
+        gzip_types
+                application/javascript
+                text/javascript
+                application/json
+                application/xml
+                application/rss+xml
+                text/css
+                text/plain
+                image/svg+xml;
 
         if (!-e $request_filename) {