Update docs

nginxinc · Apr 27, 2024 · 9ffe12e · 9ffe12e
1 parent 8dad170
commit 9ffe12e
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/common/etc/nginx/include/s3gateway.js b/common/etc/nginx/include/s3gateway.js
@@ -90,7 +90,7 @@ const INDEX_PAGE = "index.html";
 const SERVICE = process.env['S3_SERVICE'] || "s3";
 
 /**
- * Indicate whether you want to delete the x-maz headers.
+ * Indicate whether you want to delete the x-amz headers. Default remove x-amz for security reasons.
  * @type {boolean}
  */
 const S3_SERVICE_REMOVE_X_AMZ_HEADERS = utils.parseBoolean(process.env['S3_SERVICE_REMOVE_X_AMZ_HEADERS'] || 'true');

diff --git a/docs/getting_started.md b/docs/getting_started.md
@@ -44,6 +44,8 @@ running as a Container or as a Systemd service.
 | `CORS_ALLOWED_ORIGIN`                 | No        |                              |           | value to set to be returned from the CORS `Access-Control-Allow-Origin` header. This value is only used if CORS is enabled. (default: \*)                                                                                                                                                                                                                                                                                                                    |
 | `STRIP_LEADING_DIRECTORY_PATH`        | No        |                              |           | Removes a portion of the path in the requested URL (if configured). Useful when deploying to an ALB under a folder (eg. www.mysite.com/somepath).                                                                                                                                                                                                                                                                                                            |
 | `PREFIX_LEADING_DIRECTORY_PATH`       | No        |                              |           | Prefix to prepend to all S3 object paths. Useful to serve only a subset of an S3 bucket. When used in combination with `STRIP_LEADING_DIRECTORY_PATH`, this allows the leading path to be replaced, rather than just removed.                                                                                                                                                                                                                                |
+|`S3_SERVICE_REMOVE_X_AMZ_HEADERS`       | No        |   `true`, `false`          |  `true`   | Indicate whether you want to delete the x-amz headers. Default remove x-amz for security reasons.     
+|
 
 If you are using [AWS instance profile credentials](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use_switch-role-ec2.html),
 you will need to omit the `AWS_ACCESS_KEY_ID`, `AWS_SECRET_ACCESS_KEY` and `AWS_SESSION_TOKEN` variables from