Add more config

Author: barryvdh

README.md

@@ -1,7 +1,7 @@
 # Magento2 Custom Image Url
 
-Magento 2.4 has the option to set a dynamic URL (General -> Web -> Url options). This module adds an extra option to define the format of the URL.
-
+Magento 2.4 has the option to set a dynamic URL (General -> Web -> Url options). 
+This module adds an extra option to define the format of the URL.
 
 ## Install
 
@@ -13,17 +13,49 @@ php bin/magento setup:upgrade
 
 ## Configuration
 
-You can configure the url in Web -> URLS
+You can configure the url in General -> Web -> Url Options. Set the 'Catalog media URL format' option to 'Image optimization based on query parameters'. 
+This will prevent Magento from creating resized images. Select a Custom URL format for Imgproxy or Pattern, to use this module.
+
+![image](https://user-images.githubusercontent.com/973269/108608605-6cbe5b00-73c8-11eb-90dd-37777dc5d64c.png)
+
+
+### Pattern
+
+Provide a pattern to replace the URL with:
+
+Example https://example.com/{{path}}?w={{width}}&h={{height}}
+
+The available filters (for urlencode etc) and variables are described in the config.
+
+### Imgproxy
+
+![image](https://user-images.githubusercontent.com/973269/108608636-94152800-73c8-11eb-88bc-da2d6b4ed4c0.png)
+
+
+Use the Imgproxy format, either with URL, S3 or Local files. You can provide a key/hash to sign the URLs
+
+This can be used with the AWS Remote storage: https://devdocs.magento.com/guides/v2.4/config-guide/remote-storage/config-remote-storage-aws-s3.html
+
+You can provide the host and options. The format will be generated by the module.
+
+Inscecure proxy to map the URL + Convert to Webp:
+
+`docker run -p 8080:8080 -e IMGPROXY_ENFORCE_WEBP=1 darthsim/imgproxy`
+
+Example Docker config to proxy with S3 + Signature
+
+`docker run -p 8080:8080 -e IMGPROXY_USE_S3=1 -e AWS_ACCESS_KEY_ID=accesskey -e IMGPROXY_S3_REGION=eu-central-1 -e AWS_SECRET_ACCESS_KEY="secret" -e IMGPROXY_KEY=key -e IMGPROXY_SALT=salt darthsim/imgproxy`
+
+See https://docs.imgproxy.net/ for more options.
+
+See imgproxy-nginx-cached.conf for an example nginx proxy config with caching enabled.
 
-## Possibible options
- - Pattern; describe the URL based on width/height/path etc
- - Imgproxy; provide an Imgproxy host with URL/Local/S3 options, including signature
- 
 ## Todo / future ideas
 
  - Other CDNs
  - ..
- 
+
+
 ## License
 
 MIT

imgproxy-nginx-cached.conf

@@ -0,0 +1,38 @@
+# Based on https://gist.github.com/DarthSim/ee75da7da21dc984fe5e99ac86509a9f
+
+proxy_cache_path /var/www/cache levels=1:2 keys_zone=imgcache:10m max_size=1000m inactive=30d;
+proxy_temp_path /var/www/cache/tmp;
+
+server {
+    server_name your-domain.com;
+    listen 443;
+
+    client_max_body_size 8M;
+
+    ssl on;
+    ssl_certificate      /path/to/your/cert.crt;
+    ssl_certificate_key  /path/to/your/cert.key;
+
+    keepalive_timeout 60;
+    ssl_session_timeout  5m;
+
+    ssl_protocols TLSv1.2;
+    ssl_ciphers TLS13-AES-256-GCM-SHA384:TLS13-CHACHA20-POLY1305-SHA256:TLS_AES_256_GCM_SHA384:TLS-AES-256-GCM-SHA384:TLS_CHACHA20_POLY1305_SHA256:TLS-CHACHA20-POLY1305-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-ECDSA-CHACHA20-POLY1305:ECDHE-ECDSA-AES256-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-CHACHA20-POLY1305:ECDHE-RSA-AES256-SHA384:ECDHE-ECDSA-AES256-SHA:ECDHE-RSA-AES256-SHA;
+    ssl_prefer_server_ciphers   on;
+
+    location / {
+
+        proxy_cache imgcache;
+        proxy_cache_valid  200  30d;
+        proxy_cache_valid  404  1m;
+
+        if ($http_accept ~* "webp") {
+          set $webp WEBP;
+        }
+
+        proxy_cache_key    $scheme$proxy_host$request_uri$webp;
+        proxy_pass  "http://127.0.0.1:8080";
+        proxy_next_upstream error timeout invalid_header;
+        proxy_redirect off;
+    }
+}