Skip to content

docs(book/gateway): remove false mention of TLS feature impact on HTTP #1982

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

Merged
spring4175 merged 2 commits into from
Dec 28, 2022
Merged

docs(book/gateway): remove false mention of TLS feature impact on HTTP #1982

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2808b0c
docs(book): remove false TLS feature impact on HTTP
vilgotf Nov 3, 2022
de14a8b
Merge branch 'next' into vilgotf/docs/book/gateway-tls
spring4175 Dec 28, 2022
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
23 changes: 15 additions & 8 deletions book/src/chapter_1_crates/section_3_gateway.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ checks.

## Features


`twilight-gateway` includes a number of features for things ranging from
payload deserialization to TLS features.

Expand Down Expand Up @@ -44,22 +43,30 @@ This is disabled by default.

### TLS

`twilight-gateway` has features to enable [`async-tungstenite`] and
[`twilight-http`]'s TLS features. These features are mutually exclusive. `rustls`
is enabled by default.
`twilight-gateway` has features to enable [`tokio-tungstenite`]'s TLS features.
These features are mutually exclusive. `rustls-native-roots` is enabled by
default.

#### Native

The `native` feature enables [`async-tungstenite`]'s `tokio-native-tls` feature
as well as [`twilight-http`]'s `native` feature which uses `hyper-tls`.
The `native` feature enables [`tokio-tungstenite`]'s `native-tls` feature.

#### RusTLS

The `rustls` feature enables [`async-tungstenite`]'s `tokio-rustls` feature and
[`twilight-http`]'s `rustls` feature, which use [RusTLS] as the TLS backend.
RusTLS allows specifying from where certificate roots are retrieved from.

##### Native roots

The `rustls-native-roots` feature enables [`tokio-tungstenite`]'s
`rustls-tls-native-roots` feature.

This is enabled by default.

##### Web PKI roots

The `rustls-webpki-roots` feature enables [`tokio-tungstenite`]'s
`rustls-tls-webpki-roots` feature.

### Zlib

#### Stock
Expand Down