From 7de71b29a0530b0db81bea3d7e8909612e2d0899 Mon Sep 17 00:00:00 2001 From: Tatsuhiro Tsujikawa Date: Sun, 22 Aug 2021 18:07:52 +0900 Subject: [PATCH] Update doc --- README.rst | 45 ++++++++++++++++----------------------------- 1 file changed, 16 insertions(+), 29 deletions(-) diff --git a/README.rst b/README.rst index 2063d404..745f4c12 100644 --- a/README.rst +++ b/README.rst @@ -16,35 +16,6 @@ An experimental high level C++ library is also available. We have Python bindings of this library, but we do not have full code coverage yet. -Running h2load against HTTP/3 server ------------------------------------- - -In order to build h2load with HTTP/3 support, you have to build -ngtcp2, nghttp3 and my patched OpenSSL. -https://github.com/ngtcp2/ngtcp2#build-from-git describes how to build -these three software. - -To run h2load against HTTP/3 server, specify h3 ALPN with -``--npn-list`` option like so: - -.. code-block:: text - - $ h2load --npn-list h3 https://127.0.0.1:4433 - -You can use Dockerfile to skip the tedious build steps to manually -pull and build dependencies. In order to build Docker image, do this: - -.. code-block:: text - - $ cd docker - $ docker build -t nghttp2-quic . - -Run h2load: - -.. code-block:: text - - $ docker run --rm -it --network=host nghttp2-quic /usr/local/bin/h2load --npn-list h3 https://127.0.0.1:4433 - Development Status ------------------ @@ -174,6 +145,14 @@ minimizes the risk of private key leakage when serious bug like Heartbleed is exploited. The neverbleed is disabled by default. To enable it, use ``--with-neverbleed`` configure option. +To enable the experimental HTTP/3 support for h2load and nghttpx, the +following libraries are required: + +* `OpenSSL with QUIC support + `_ +* `ngtcp2 `_ +* `nghttp3 `_ + Compiling libnghttp2 C source code requires a C99 compiler. gcc 4.8 is known to be adequate. In order to compile the C++ source code, gcc >= 6.0 or clang >= 6.0 is required. C++ source code requires C++14 @@ -904,6 +883,14 @@ threads to avoid saturating a single core on client side. considered a DOS attack. Please only use it against your private servers. +If the experimental HTTP/3 is enabled, h2load can send requests to +HTTP/3 server. To do this, specify ``h3`` to ``--npn-list`` option +like so: + +.. code-block:: text + + $ h2load --npn-list h3 https://127.0.0.1:4433 + HPACK tools -----------