Skip to content

Document HTTP/2 authority header behavior #737

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
nbarbier-265 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Document HTTP/2 authority header behavior #737

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 16 additions & 0 deletions docs/user_guide/modify_filter.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,22 @@ impl ProxyHttp for MyGateway {
```


## Accessing request headers

Request headers can be accessed through `session.req_header()`. For HTTP/1.1 and HTTP/2 requests, the API provides a unified interface for header access.

### Host header

To get the request host, use the standard `HOST` header. For HTTP/2 requests, Pingora automatically maps the `:authority` pseudo-header to the `HOST` header for compatibility.

```Rust
use http::header::HOST;

let host = session.req_header().headers.get(HOST);
```

For HTTP/1.1 requests, this returns the `Host` header value. For HTTP/2 requests, this returns the `:authority` pseudo-header value.

## Modifying headers

Both request and response headers can be added, removed or modified in their corresponding phases. In the following example, we add logic to the `response_filter` phase to update the `Server` header and remove the `alt-svc` header.
Expand Down