<!DOCTYPE html> <!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]--> <!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]--> <head> <meta charset="utf-8"> <meta name="viewport" content="width=device-width, initial-scale=1.0"> <title>nghttpd(1) — nghttp2 1.38.0 documentation</title> <link rel="stylesheet" href="_static/css/theme.css" type="text/css" /> <link rel="index" title="Index" href="genindex.html"/> <link rel="search" title="Search" href="search.html"/> <link rel="top" title="nghttp2 1.38.0 documentation" href="index.html"/> <link rel="next" title="nghttpx(1)" href="nghttpx.1.html"/> <link rel="prev" title="nghttp(1)" href="nghttp.1.html"/> <script src="_static/js/modernizr.min.js"></script> </head> <body class="wy-body-for-nav" role="document"> <div class="wy-grid-for-nav"> <nav data-toggle="wy-nav-shift" class="wy-nav-side"> <div class="wy-side-scroll"> <div class="wy-side-nav-search"> <a href="index.html" class="icon icon-home"> nghttp2 </a> <div class="version"> 1.38.0 </div> <div role="search"> <form id="rtd-search-form" class="wy-form" action="search.html" method="get"> <input type="text" name="q" placeholder="Search docs" /> <input type="hidden" name="check_keywords" value="yes" /> <input type="hidden" name="area" value="default" /> </form> </div> </div> <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation"> <ul class="current"> <li class="toctree-l1"><a class="reference internal" href="package_README.html">nghttp2 - HTTP/2 C Library</a></li> <li class="toctree-l1"><a class="reference internal" href="contribute.html">Contribution Guidelines</a></li> <li class="toctree-l1"><a class="reference internal" href="building-android-binary.html">Building Android binary</a></li> <li class="toctree-l1"><a class="reference internal" href="tutorial-client.html">Tutorial: HTTP/2 client</a></li> <li class="toctree-l1"><a class="reference internal" href="tutorial-server.html">Tutorial: HTTP/2 server</a></li> <li class="toctree-l1"><a class="reference internal" href="tutorial-hpack.html">Tutorial: HPACK API</a></li> <li class="toctree-l1"><a class="reference internal" href="nghttp.1.html">nghttp(1)</a></li> <li class="toctree-l1 current"><a class="current reference internal" href="#">nghttpd(1)</a><ul> <li class="toctree-l2"><a class="reference internal" href="#synopsis">SYNOPSIS</a></li> <li class="toctree-l2"><a class="reference internal" href="#description">DESCRIPTION</a></li> <li class="toctree-l2"><a class="reference internal" href="#options">OPTIONS</a></li> <li class="toctree-l2"><a class="reference internal" href="#see-also">SEE ALSO</a></li> </ul> </li> <li class="toctree-l1"><a class="reference internal" href="nghttpx.1.html">nghttpx(1)</a></li> <li class="toctree-l1"><a class="reference internal" href="h2load.1.html">h2load(1)</a></li> <li class="toctree-l1"><a class="reference internal" href="nghttpx-howto.html">nghttpx - HTTP/2 proxy - HOW-TO</a></li> <li class="toctree-l1"><a class="reference internal" href="h2load-howto.html">h2load - HTTP/2 benchmarking tool - HOW-TO</a></li> <li class="toctree-l1"><a class="reference internal" href="programmers-guide.html">Programmers’ Guide</a></li> <li class="toctree-l1"><a class="reference internal" href="apiref.html">API Reference</a></li> <li class="toctree-l1"><a class="reference internal" href="libnghttp2_asio.html">libnghttp2_asio: High level HTTP/2 C++ library</a></li> <li class="toctree-l1"><a class="reference internal" href="python-apiref.html">Python API Reference</a></li> <li class="toctree-l1"><a class="reference internal" href="nghttp2.h.html">nghttp2.h</a></li> <li class="toctree-l1"><a class="reference internal" href="nghttp2ver.h.html">nghttp2ver.h</a></li> <li class="toctree-l1"><a class="reference internal" href="asio_http2_server.h.html">asio_http2_server.h</a></li> <li class="toctree-l1"><a class="reference internal" href="asio_http2_client.h.html">asio_http2_client.h</a></li> <li class="toctree-l1"><a class="reference internal" href="asio_http2.h.html">asio_http2.h</a></li> <li class="toctree-l1"><a class="reference external" href="https://github.com/nghttp2/nghttp2">Source</a></li> <li class="toctree-l1"><a class="reference external" href="https://github.com/nghttp2/nghttp2/issues">Issues</a></li> <li class="toctree-l1"><a class="reference external" href="https://nghttp2.org/">nghttp2.org</a></li> </ul> </div> </div> </nav> <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap"> <nav class="wy-nav-top" role="navigation" aria-label="top navigation"> <i data-toggle="wy-nav-top" class="fa fa-bars"></i> <a href="index.html">nghttp2</a> </nav> <div class="wy-nav-content"> <div class="rst-content"> <div role="navigation" aria-label="breadcrumbs navigation"> <ul class="wy-breadcrumbs"> <li><a href="index.html">Docs</a> »</li> <li>nghttpd(1)</li> <li class="wy-breadcrumbs-aside"> </li> </ul> <hr/> </div> <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article"> <div itemprop="articleBody"> <div class="section" id="nghttpd-1"> <h1>nghttpd(1)<a class="headerlink" href="#nghttpd-1" title="Permalink to this headline">¶</a></h1> <div class="section" id="synopsis"> <h2>SYNOPSIS<a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h2> <p><strong>nghttpd</strong> [OPTION]… <PORT> [<PRIVATE_KEY> <CERT>]</p> </div> <div class="section" id="description"> <h2>DESCRIPTION<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2> <p>HTTP/2 server</p> <dl class="describe"> <dt> <code class="descname"><PORT></code></dt> <dd><p>Specify listening port number.</p> </dd></dl> <dl class="describe"> <dt> <code class="descname"><PRIVATE_KEY></code></dt> <dd><p>Set path to server’s private key. Required unless <a class="reference internal" href="#cmdoption-nghttpd-no-tls"><code class="xref std std-option docutils literal notranslate"><span class="pre">--no-tls</span></code></a> is specified.</p> </dd></dl> <dl class="describe"> <dt> <code class="descname"><CERT></code></dt> <dd><p>Set path to server’s certificate. Required unless <a class="reference internal" href="#cmdoption-nghttpd-no-tls"><code class="xref std std-option docutils literal notranslate"><span class="pre">--no-tls</span></code></a> is specified.</p> </dd></dl> </div> <div class="section" id="options"> <h2>OPTIONS<a class="headerlink" href="#options" title="Permalink to this headline">¶</a></h2> <dl class="option"> <dt id="cmdoption-nghttpd-a"> <code class="descname">-a</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--address</code><code class="descclassname">=<ADDR></code><a class="headerlink" href="#cmdoption-nghttpd-a" title="Permalink to this definition">¶</a></dt> <dd><p>The address to bind to. If not specified the default IP address determined by getaddrinfo is used.</p> </dd></dl> <dl class="option"> <dt id="cmdoption-nghttpd-d"> <code class="descname">-D</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--daemon</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-nghttpd-d" title="Permalink to this definition">¶</a></dt> <dd><p>Run in a background. If <a class="reference internal" href="#cmdoption-nghttpd-d"><code class="xref std std-option docutils literal notranslate"><span class="pre">-D</span></code></a> is used, the current working directory is changed to ‘<em>/</em>’. Therefore if this option is used, <a class="reference internal" href="#cmdoption-nghttpd-htdocs"><code class="xref std std-option docutils literal notranslate"><span class="pre">-d</span></code></a> option must be specified.</p> </dd></dl> <dl class="option"> <dt id="cmdoption-nghttpd-v"> <code class="descname">-V</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--verify-client</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-nghttpd-v" title="Permalink to this definition">¶</a></dt> <dd><p>The server sends a client certificate request. If the client did not return a certificate, the handshake is terminated. Currently, this option just requests a client certificate and does not verify it.</p> </dd></dl> <dl class="option"> <dt id="cmdoption-nghttpd-htdocs"> <code class="descname">-d</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--htdocs</code><code class="descclassname">=<PATH></code><a class="headerlink" href="#cmdoption-nghttpd-htdocs" title="Permalink to this definition">¶</a></dt> <dd><p>Specify document root. If this option is not specified, the document root is the current working directory.</p> </dd></dl> <dl class="option"> <dt id="cmdoption-nghttpd-verbose"> <code class="descname">-v</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--verbose</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-nghttpd-verbose" title="Permalink to this definition">¶</a></dt> <dd><p>Print debug information such as reception/ transmission of frames and name/value pairs.</p> </dd></dl> <dl class="option"> <dt id="cmdoption-nghttpd-no-tls"> <code class="descname">--no-tls</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-nghttpd-no-tls" title="Permalink to this definition">¶</a></dt> <dd><p>Disable SSL/TLS.</p> </dd></dl> <dl class="option"> <dt id="cmdoption-nghttpd-c"> <code class="descname">-c</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--header-table-size</code><code class="descclassname">=<SIZE></code><a class="headerlink" href="#cmdoption-nghttpd-c" title="Permalink to this definition">¶</a></dt> <dd><p>Specify decoder header table size.</p> </dd></dl> <dl class="option"> <dt id="cmdoption-nghttpd-encoder-header-table-size"> <code class="descname">--encoder-header-table-size</code><code class="descclassname">=<SIZE></code><a class="headerlink" href="#cmdoption-nghttpd-encoder-header-table-size" title="Permalink to this definition">¶</a></dt> <dd><p>Specify encoder header table size. The decoder (client) specifies the maximum dynamic table size it accepts. Then the negotiated dynamic table size is the minimum of this option value and the value which client specified.</p> </dd></dl> <dl class="option"> <dt id="cmdoption-nghttpd-color"> <code class="descname">--color</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-nghttpd-color" title="Permalink to this definition">¶</a></dt> <dd><p>Force colored log output.</p> </dd></dl> <dl class="option"> <dt id="cmdoption-nghttpd-p"> <code class="descname">-p</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--push</code><code class="descclassname">=<PATH>=<PUSH_PATH,...></code><a class="headerlink" href="#cmdoption-nghttpd-p" title="Permalink to this definition">¶</a></dt> <dd><p>Push resources <PUSH_PATH>s when <PATH> is requested. This option can be used repeatedly to specify multiple push configurations. <PATH> and <PUSH_PATH>s are relative to document root. See <a class="reference internal" href="#cmdoption-nghttpd-htdocs"><code class="xref std std-option docutils literal notranslate"><span class="pre">--htdocs</span></code></a> option. Example: <a class="reference internal" href="#cmdoption-nghttpd-p"><code class="xref std std-option docutils literal notranslate"><span class="pre">-p</span></code></a>/=/foo.png <a class="reference internal" href="#cmdoption-nghttpd-p"><code class="xref std std-option docutils literal notranslate"><span class="pre">-p</span></code></a>/doc=/bar.css</p> </dd></dl> <dl class="option"> <dt id="cmdoption-nghttpd-b"> <code class="descname">-b</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--padding</code><code class="descclassname">=<N></code><a class="headerlink" href="#cmdoption-nghttpd-b" title="Permalink to this definition">¶</a></dt> <dd><p>Add at most <N> bytes to a frame payload as padding. Specify 0 to disable padding.</p> </dd></dl> <dl class="option"> <dt id="cmdoption-nghttpd-m"> <code class="descname">-m</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--max-concurrent-streams</code><code class="descclassname">=<N></code><a class="headerlink" href="#cmdoption-nghttpd-m" title="Permalink to this definition">¶</a></dt> <dd><p>Set the maximum number of the concurrent streams in one HTTP/2 session.</p> <p>Default: <code class="docutils literal notranslate"><span class="pre">100</span></code></p> </dd></dl> <dl class="option"> <dt id="cmdoption-nghttpd-n"> <code class="descname">-n</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--workers</code><code class="descclassname">=<N></code><a class="headerlink" href="#cmdoption-nghttpd-n" title="Permalink to this definition">¶</a></dt> <dd><p>Set the number of worker threads.</p> <p>Default: <code class="docutils literal notranslate"><span class="pre">1</span></code></p> </dd></dl> <dl class="option"> <dt id="cmdoption-nghttpd-e"> <code class="descname">-e</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--error-gzip</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-nghttpd-e" title="Permalink to this definition">¶</a></dt> <dd><p>Make error response gzipped.</p> </dd></dl> <dl class="option"> <dt id="cmdoption-nghttpd-w"> <code class="descname">-w</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--window-bits</code><code class="descclassname">=<N></code><a class="headerlink" href="#cmdoption-nghttpd-w" title="Permalink to this definition">¶</a></dt> <dd><p>Sets the stream level initial window size to 2**<N>-1.</p> </dd></dl> <dl class="option"> <dt id="cmdoption-nghttpd-connection-window-bits"> <code class="descname">-W</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--connection-window-bits</code><code class="descclassname">=<N></code><a class="headerlink" href="#cmdoption-nghttpd-connection-window-bits" title="Permalink to this definition">¶</a></dt> <dd><p>Sets the connection level initial window size to 2**<N>-1.</p> </dd></dl> <dl class="option"> <dt id="cmdoption-nghttpd-dh-param-file"> <code class="descname">--dh-param-file</code><code class="descclassname">=<PATH></code><a class="headerlink" href="#cmdoption-nghttpd-dh-param-file" title="Permalink to this definition">¶</a></dt> <dd><p>Path to file that contains DH parameters in PEM format. Without this option, DHE cipher suites are not available.</p> </dd></dl> <dl class="option"> <dt id="cmdoption-nghttpd-early-response"> <code class="descname">--early-response</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-nghttpd-early-response" title="Permalink to this definition">¶</a></dt> <dd><p>Start sending response when request HEADERS is received, rather than complete request is received.</p> </dd></dl> <dl class="option"> <dt id="cmdoption-nghttpd-trailer"> <code class="descname">--trailer</code><code class="descclassname">=<HEADER></code><a class="headerlink" href="#cmdoption-nghttpd-trailer" title="Permalink to this definition">¶</a></dt> <dd><p>Add a trailer header to a response. <HEADER> must not include pseudo header field (header field name starting with ‘:’). The trailer is sent only if a response has body part. Example: <a class="reference internal" href="#cmdoption-nghttpd-trailer"><code class="xref std std-option docutils literal notranslate"><span class="pre">--trailer</span></code></a> ‘foo: bar’.</p> </dd></dl> <dl class="option"> <dt id="cmdoption-nghttpd-hexdump"> <code class="descname">--hexdump</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-nghttpd-hexdump" title="Permalink to this definition">¶</a></dt> <dd><p>Display the incoming traffic in hexadecimal (Canonical hex+ASCII display). If SSL/TLS is used, decrypted data are used.</p> </dd></dl> <dl class="option"> <dt id="cmdoption-nghttpd-echo-upload"> <code class="descname">--echo-upload</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-nghttpd-echo-upload" title="Permalink to this definition">¶</a></dt> <dd><p>Send back uploaded content if method is POST or PUT.</p> </dd></dl> <dl class="option"> <dt id="cmdoption-nghttpd-mime-types-file"> <code class="descname">--mime-types-file</code><code class="descclassname">=<PATH></code><a class="headerlink" href="#cmdoption-nghttpd-mime-types-file" title="Permalink to this definition">¶</a></dt> <dd><p>Path to file that contains MIME media types and the extensions that represent them.</p> <p>Default: <code class="docutils literal notranslate"><span class="pre">/etc/mime.types</span></code></p> </dd></dl> <dl class="option"> <dt id="cmdoption-nghttpd-no-content-length"> <code class="descname">--no-content-length</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-nghttpd-no-content-length" title="Permalink to this definition">¶</a></dt> <dd><p>Don’t send content-length header field.</p> </dd></dl> <dl class="option"> <dt id="cmdoption-nghttpd-version"> <code class="descname">--version</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-nghttpd-version" title="Permalink to this definition">¶</a></dt> <dd><p>Display version information and exit.</p> </dd></dl> <dl class="option"> <dt id="cmdoption-nghttpd-h"> <code class="descname">-h</code><code class="descclassname"></code><code class="descclassname">, </code><code class="descname">--help</code><code class="descclassname"></code><a class="headerlink" href="#cmdoption-nghttpd-h" title="Permalink to this definition">¶</a></dt> <dd><p>Display this help and exit.</p> </dd></dl> <p>The <SIZE> argument is an integer and an optional unit (e.g., 10K is 10 * 1024). Units are K, M and G (powers of 1024).</p> </div> <div class="section" id="see-also"> <h2>SEE ALSO<a class="headerlink" href="#see-also" title="Permalink to this headline">¶</a></h2> <p><em class="manpage">nghttp(1)</em>, <em class="manpage">nghttpx(1)</em>, <em class="manpage">h2load(1)</em></p> </div> </div> </div> </div> <footer> <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation"> <a href="nghttpx.1.html" class="btn btn-neutral float-right" title="nghttpx(1)" accesskey="n">Next <span class="fa fa-arrow-circle-right"></span></a> <a href="nghttp.1.html" class="btn btn-neutral" title="nghttp(1)" accesskey="p"><span class="fa fa-arrow-circle-left"></span> Previous</a> </div> <hr/> <div role="contentinfo"> <p> © Copyright 2012, 2015, 2016, Tatsuhiro Tsujikawa. </p> </div> Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/snide/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. </footer> </div> </div> </section> </div> <script type="text/javascript"> var DOCUMENTATION_OPTIONS = { URL_ROOT:'./', VERSION:'1.38.0', COLLAPSE_INDEX:false, FILE_SUFFIX:'.html', HAS_SOURCE: false }; </script> <script type="text/javascript" src="_static/jquery.js"></script> <script type="text/javascript" src="_static/underscore.js"></script> <script type="text/javascript" src="_static/doctools.js"></script> <script type="text/javascript" src="_static/language_data.js"></script> <script type="text/javascript" src="_static/js/theme.js"></script> <script type="text/javascript"> jQuery(function () { SphinxRtdTheme.StickyNav.enable(); }); </script> </body> </html>