Skip to content

Commit 803fb5c

Browse files
committed
docs(config): add admonitions for more details
1 parent 8a82d3d commit 803fb5c

File tree

1 file changed

+7
-0
lines changed

1 file changed

+7
-0
lines changed

docs/user-guide/configuration.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,10 @@ The application is configurable via environment variables.
5252
- **Required:** No, defaults to `true`
5353
- **Example:** `false`, `1`, `True`
5454

55+
> [!TIP]
56+
> **Default behavior (`true`):** The proxy overrides the [`Host` header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Host) in incoming requests to match the upstream STAC API's origin. This ensures the upstream API constructs `link` elements correctly based on the [`Forwarded` header](https://developer.mozilla.org/en-US/docs/Web/HTTP/Reference/Headers/Forwarded).
57+
>
58+
> **When to disable (`false`):** Set to `false` if your upstream STAC API doesn't make use of proxy headers. In this case, the original `Host` header is preserved, allowing the upstream API to generate `link` elements based on the proxy's URL instead.
5559

5660
### `ROOT_PATH`
5761

@@ -90,6 +94,9 @@ The application is configurable via environment variables.
9094
- **Required:** No
9195
- **Example:** `https://auth.example.audience.1.net,https://auth.example.audience.2.net`
9296

97+
> [!NOTE]
98+
> A comma-separated list of the intended recipient(s) of the JWT. At least one audience value must match the `aud` (audience) claim present in the incoming JWT. If unset, the API will not impose a check on the `aud` claim
99+
93100
### `DEFAULT_PUBLIC`
94101

95102
: Default access policy for endpoints

0 commit comments

Comments
 (0)