Browse Source

Update docs and changelog

DarthSim 2 years ago
parent
commit
b17d6c400c
3 changed files with 22 additions and 1 deletions
  1. 2 0
      CHANGELOG.md
  2. 1 1
      docs/configuration.md
  3. 19 0
      docs/getting_the_image_info.md

+ 2 - 0
CHANGELOG.md

@@ -3,6 +3,8 @@
 ## [Unreleased]
 ### Add
 - Add `IMGPROXY_OPEN_TELEMETRY_GRPC_INSECURE` config.
+- (pro) Add XMP data to the `/info` response.
+- (pro) Better XMP data stripping.
 
 ## [3.10.0] - 2022-11-04
 ### Add

+ 1 - 1
docs/configuration.md

@@ -407,7 +407,7 @@ imgproxy can send request traces to an OpenTelemetry collector:
 * `IMGPROXY_OPEN_TELEMETRY_SERVER_CERT`: OpenTelemetry collector TLS certificate, PEM-encoded. Default: blank
 * `IMGPROXY_OPEN_TELEMETRY_CLIENT_CERT`: OpenTelemetry client TLS certificate, PEM-encoded. Default: blank
 * `IMGPROXY_OPEN_TELEMETRY_CLIENT_KEY`: OpenTelemetry client TLS key, PEM-encoded. Default: blank
-* `IMGPROXY_OPEN_TELEMETRY_GRPC_INSECURE`: when `true`, `IMGPROXY_OPEN_TELEMETRY_PROTOCOL` is set to `grpc`, and the collector TLS certificate is not provided, imgproxy will use an insecure GRPC connection. Default: `true`
+* `IMGPROXY_OPEN_TELEMETRY_GRPC_INSECURE`: when `true`, imgproxy will use an insecure GRPC connection unless the collector TLS certificate is not provided. Default: `true`
 * `IMGPROXY_OPEN_TELEMETRY_PROPAGATORS`: a list of OpenTelemetry text map propagators, comma divided. Supported propagators are `tracecontext`, `baggage`, `b3`, `b3multi`, `jaeger`, `xray`, and `ottrace`. Default: blank
 * `IMGPROXY_OPEN_TELEMETRY_CONNECTION_TIMEOUT`: the maximum duration (in seconds) for establishing a connection to the OpenTelemetry collector. Default: `5`
 

+ 19 - 0
docs/getting_the_image_info.md

@@ -78,6 +78,25 @@ imgproxy responses with a JSON body and returns the following info:
     "Caption": "Spider-Man swings on the web",
     "Copyright Notice": "Daily Bugle",
     "Keywords": ["spider-man", "menance", "offender"]
+  },
+  "xmp": {
+    "aux": {
+      "ApproximateFocusDistance": "4294967295/1",
+      "ImageNumber": "16604",
+      "Lens": "16.0-35.0 mm f/4.0",
+      "LensID": "163",
+      "LensInfo": "160/10 350/10 40/10 40/10",
+      "SerialNumber": "12345678"
+    },
+    "dc": {
+      "creator": ["Peter B. Parker"],
+      "publisher": ["Daily Bugle"],
+      "subject": ["spider-man", "menance", "offender"],
+      "format": "image/jpeg"
+    },
+    "photoshop": {
+      "DateCreated": "2016-09-11T18:44:50.003"
+    }
   }
 }
 ```