Commit 1f420fc
doc: add note about browsers and HTTP/2
Backport-PR-URL: #20456
PR-URL: #19476
Reviewed-By: Trivikram Kamat <trivikr.dev@gmail.com>
Reviewed-By: Matteo Collina <matteo.collina@gmail.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>1 parent 7321dd3 commit 1f420fc
1 file changed
Lines changed: 16 additions & 4 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -24,8 +24,11 @@ be emitted either by client-side code or server-side code. | |||
| 24 | 24 | ||
| 25 | 25 | ### Server-side example | |
| 26 | 26 | ||
| 27 | - The following illustrates a simple, plain-text HTTP/2 server using the | ||
| 28 | - Core API: | ||
| 27 | + The following illustrates a simple HTTP/2 server using the Core API. | ||
| 28 | + Since there are no browsers known that support | ||
| 29 | + [unencrypted HTTP/2][HTTP/2 Unencrypted], the use of | ||
| 30 | + [`http2.createSecureServer()`][] is necessary when communicating | ||
| 31 | + with browser clients. | ||
| 29 | 32 | ||
| 30 | 33 | ```js | |
| 31 | 34 | const http2 = require('http2'); | |
@@ -253,7 +256,7 @@ and would instead register a handler for the `'stream'` event emitted by the | |||
| 253 | 256 | ```js | |
| 254 | 257 | const http2 = require('http2'); | |
| 255 | 258 | ||
| 256 | - // Create a plain-text HTTP/2 server | ||
| 259 | + // Create an unencrypted HTTP/2 server | ||
| 257 | 260 | const server = http2.createServer(); | |
| 258 | 261 | ||
| 259 | 262 | server.on('stream', (stream, headers) => { | |
@@ -1735,10 +1738,18 @@ changes: | |||
| 1735 | 1738 | Returns a `net.Server` instance that creates and manages `Http2Session` | |
| 1736 | 1739 | instances. | |
| 1737 | 1740 | ||
| 1741 | + Since there are no browsers known that support | ||
| 1742 | + [unencrypted HTTP/2][HTTP/2 Unencrypted], the use of | ||
| 1743 | + [`http2.createSecureServer()`][] is necessary when communicating | ||
| 1744 | + with browser clients. | ||
| 1745 | + | ||
| 1738 | 1746 | ```js | |
| 1739 | 1747 | const http2 = require('http2'); | |
| 1740 | 1748 | ||
| 1741 | - // Create a plain-text HTTP/2 server | ||
| 1749 | + // Create an unencrypted HTTP/2 server. | ||
| 1750 | + // Since there are no browsers known that support | ||
| 1751 | + // unencrypted HTTP/2, the use of `http2.createSecureServer()` | ||
| 1752 | + // is necessary when communicating with browser clients. | ||
| 1742 | 1753 | const server = http2.createServer(); | |
| 1743 | 1754 | ||
| 1744 | 1755 | server.on('stream', (stream, headers) => { | |
@@ -3093,6 +3104,7 @@ following additional properties: | |||
| 3093 | 3104 | [Compatibility API]: #http2_compatibility_api | |
| 3094 | 3105 | [HTTP/1]: http.html | |
| 3095 | 3106 | [HTTP/2]: https://tools.ietf.org/html/rfc7540 | |
| 3107 | + [HTTP/2 Unencrypted]: https://http2.github.io/faq/#does-http2-require-encryption | ||
| 3096 | 3108 | [HTTP2 Headers Object]: #http2_headers_object | |
| 3097 | 3109 | [HTTP2 Settings Object]: #http2_settings_object | |
| 3098 | 3110 | [HTTPS]: https.html | |
0 commit comments