Skip to content

Commit 3e3fd56

Browse files
rmcsqrddekobon
authored andcommitted
update getting_started w/ debugging information
In response to nginx#38
1 parent edae320 commit 3e3fd56

File tree

1 file changed

+16
-4
lines changed

1 file changed

+16
-4
lines changed

docs/getting_started.md

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,11 @@
22

33
## Contents
44

5-
[Configuration](#configuration)
6-
[Running as a Systemd Service](#running-as-a-systemd-service)
7-
[Running in Containers](#running-in-containers)
8-
[Running Using AWS Instance Profile Credentials](#running-using-aws-instance-profile-credentials)
5+
[Configuration](#configuration)
6+
[Running as a Systemd Service](#running-as-a-systemd-service)
7+
[Running in Containers](#running-in-containers)
8+
[Running Using AWS Instance Profile Credentials](#running-using-aws-instance-profile-credentials)
9+
[Troubleshooting](#troubleshooting)
910

1011
## Configuration
1112

@@ -249,3 +250,14 @@ modified.
249250
aws cloudformation delete-stack \
250251
--stack-name nginx-s3-gateway
251252
```
253+
## Troubleshooting
254+
255+
### Disable default `404` error message
256+
The default behavior of the container is to return a `404` error message for any non-`200` response code. This is implemented as a security feature to sanitize any error response from the S3 bucket being proxied. For container debugging purposes, this sanitization can be turned off by commenting out the following lines within [`default.conf.template`](https://github.com/nginxinc/nginx-s3-gateway/blob/master/common/etc/nginx/templates/default.conf.template).
257+
```bash
258+
proxy_intercept_errors on;
259+
error_page 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 420 422 423 424 426 428 429 431 444 449 450 451 500 501 502 503 504 505 506 507 508 509 510 511 =404 @error404;
260+
```
261+
262+
### Error `403 Access Denied` for AWS Accounts with MFA Enabled
263+
The REST authentication method used in this container does not work with AWS IAM roles that have MFA enabled for authentication. Please use AWS IAM role credentials that do not have MFA enabled.

0 commit comments

Comments
 (0)