Skip to content

Commit

Permalink
update custom headers to mention 1.9 is required (#13155)
Browse files Browse the repository at this point in the history
* update custom headers to mention 1.9 is required

Per https://github.com/hashicorp/vault/blob/main/CHANGELOG.md#190-rc1 the custom response headers are a new feature introduced in 1.9, meaning we should explicitly call out this version requirement in documentation, otherwise users of earlier versions of Vault will unable to use the functionality and may consider it a bug.

* Update website/content/docs/configuration/listener/tcp.mdx

reads better, agreed

Co-authored-by: Loann Le <84412881+taoism4504@users.noreply.github.com>

Co-authored-by: Loann Le <84412881+taoism4504@users.noreply.github.com>
  • Loading branch information
2 people authored and actions-user committed Dec 1, 2021
1 parent 1943b15 commit f231126
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions website/content/docs/configuration/listener/tcp.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ specify [`api_addr`][api-addr] and [`cluster_addr`][cluster-addr] so Vault will
advertise the correct address to other nodes.

## Listener's custom response headers
Vault supports defining custom HTTP response headers for the root path (`/`) and also on API endpoints (`/v1/*`).
As of version 1.9, Vault supports defining custom HTTP response headers for the root path (`/`) and also on API endpoints (`/v1/*`).
The headers are defined based on the returned status code. For example, a user can define a list of
custom response headers for the `200` status code, and another list of custom response headers for
the `307` status code. There is a `"/sys/config/ui"` [API endpoint](/api/system/config-ui) which allows users
Expand Down Expand Up @@ -260,8 +260,8 @@ listener "tcp" {

### Configuring custom http response headers

This example shows configuring custom http response headers. Operators can configure
`"custom_response_headers"` sub-stanza in the listener stanza to set custom http
Note: Requires Vault version 1.9 or newer. This example shows configuring custom http response headers.
Operators can configure `"custom_response_headers"` sub-stanza in the listener stanza to set custom http
headers appropriate to their applications. Examples of such headers are `"Strict-Transport-Security"`
and `"Content-Security-Policy"` which are known HTTP headers, and could be configured to harden
the security of an application communicating with the Vault endpoints. Note that vulnerability
Expand Down

0 comments on commit f231126

Please sign in to comment.