Merge pull request #75 from rohang98/readme-take-2

Adds flags into README
awslabs · Sep 16, 2022 · 262511e · 262511e
2 parents 51cd68d + 087e236
commit 262511e
Show file tree

Hide file tree

Showing 2 changed files with 19 additions and 0 deletions.
diff --git a/.gitignore b/.gitignore
@@ -1 +1,2 @@
 .vscode
+.idea/
diff --git a/README.md b/README.md
@@ -35,6 +35,24 @@ docker run --rm -ti \
   aws-sigv4-proxy -v
 ```
 
+### Configuration
+
+When running the Proxy, the following flags can be used (none are required) :
+
+| Flag (or short form)          | Type     | Description                                              | Default |
+|-------------------------------|----------|----------------------------------------------------------|---------|
+| `verbose` or `v`              | Boolean  | Enable additional logging, implies all the log-* options | `False` |
+| `log-failed-requests`         | Boolean  | Log 4xx and 5xx response body                            | `False` |
+| `log-signing-process`         | Boolean  | Log sigv4 signing process                                | `False` |
+| `port`                        | String   | Port to serve http on                                    | `8080`  |
+| `strip` or `s`                | String   | Headers to strip from incoming request                   | None    |
+| `role-arn`                    | String   | Amazon Resource Name (ARN) of the role to assume         | None    |
+| `name`                        | String   | AWS Service to sign for                                  | None    |
+| `host`                        | String   | Host to proxy to                                         | None    |
+| `region`                      | String   | AWS region to sign for                                   | None    |
+| `no-verify-ssl`               | Boolean  | Disable peer SSL certificate validation                  | `False` |
+| `transport.idle-conn-timeout` | Duration | Idle timeout to the upstream service                     | `40s`   |
+
 ## Examples
 
 S3