<liclass="toctree-l2"><aclass="reference internal"href="package_README.html#client-server-and-proxy-programs">Client, Server and Proxy programs</a></li>
<liclass="toctree-l2"><aclass="reference internal"href="nghttpx-howto.html#specifying-additional-ca-certificate">Specifying additional CA certificate</a></li>
<h2>DESCRIPTION<aclass="headerlink"href="#description"title="Permalink to this headline">¶</a></h2>
<p>A reverse proxy for HTTP/2, HTTP/1 and SPDY.</p>
<dlclass="option">
<dtid="cmdoption-nghttpx-arg-PRIVATE_KEY">
<ttclass="descname">PRIVATE_KEY</tt><ttclass="descclassname"></tt><aclass="headerlink"href="#cmdoption-nghttpx-arg-PRIVATE_KEY"title="Permalink to this definition">¶</a></dt>
<dd><p>Set path to server’s private key. Required
unless <aclass="reference internal"href="#cmdoption-nghttpx-p"><emclass="xref std std-option">-p</em></a>, <aclass="reference internal"href="#cmdoption-nghttpx--client"><emclass="xref std std-option">--client</em></a> or <aclass="reference internal"href="#cmdoption-nghttpx--frontend-no-tls"><emclass="xref std std-option">--frontend-no-tls</em></a> are
given.</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-nghttpx-arg-CERT">
<ttclass="descname">CERT</tt><ttclass="descclassname"></tt><aclass="headerlink"href="#cmdoption-nghttpx-arg-CERT"title="Permalink to this definition">¶</a></dt>
<dd><p>Set path to server’s certificate. Required
unless <aclass="reference internal"href="#cmdoption-nghttpx-p"><emclass="xref std std-option">-p</em></a>, <aclass="reference internal"href="#cmdoption-nghttpx--client"><emclass="xref std std-option">--client</em></a> or <aclass="reference internal"href="#cmdoption-nghttpx--frontend-no-tls"><emclass="xref std std-option">--frontend-no-tls</em></a> are
given.</p>
</dd></dl>
</div>
<divclass="section"id="options">
<h2>OPTIONS<aclass="headerlink"href="#options"title="Permalink to this headline">¶</a></h2>
<p>The options are categorized into several groups.</p>
<divclass="section"id="connections">
<h3>Connections<aclass="headerlink"href="#connections"title="Permalink to this headline">¶</a></h3>
<dlclass="option">
<dtid="cmdoption-nghttpx-b">
<spanid="cmdoption-nghttpx--backend"></span><ttclass="descname">-b</tt><ttclass="descclassname"></tt><ttclass="descclassname">, </tt><ttclass="descname">--backend</tt><ttclass="descclassname">=<HOST,PORT></tt><aclass="headerlink"href="#cmdoption-nghttpx-b"title="Permalink to this definition">¶</a></dt>
<dd><p>Set backend host and port.
Default: ‘127.0.0.1,80’</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-nghttpx-f">
<spanid="cmdoption-nghttpx--frontend"></span><ttclass="descname">-f</tt><ttclass="descclassname"></tt><ttclass="descclassname">, </tt><ttclass="descname">--frontend</tt><ttclass="descclassname">=<HOST,PORT></tt><aclass="headerlink"href="#cmdoption-nghttpx-f"title="Permalink to this definition">¶</a></dt>
<dd><p>Set frontend host and port. If <HOST> is ‘*’, it
assumes all addresses including both IPv4 and
IPv6.
Default: ‘*,3000’</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-nghttpx--backlog">
<ttclass="descname">--backlog</tt><ttclass="descclassname">=<NUM></tt><aclass="headerlink"href="#cmdoption-nghttpx--backlog"title="Permalink to this definition">¶</a></dt>
<dd><p>Set listen backlog size. If -1 is given,
libevent will choose suitable value.
Default: -1</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-nghttpx--backend-ipv4">
<ttclass="descname">--backend-ipv4</tt><ttclass="descclassname"></tt><aclass="headerlink"href="#cmdoption-nghttpx--backend-ipv4"title="Permalink to this definition">¶</a></dt>
<dd><p>Resolve backend hostname to IPv4 address only.</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-nghttpx--backend-ipv6">
<ttclass="descname">--backend-ipv6</tt><ttclass="descclassname"></tt><aclass="headerlink"href="#cmdoption-nghttpx--backend-ipv6"title="Permalink to this definition">¶</a></dt>
<dd><p>Resolve backend hostname to IPv6 address only.</p>
<ttclass="descname">--backend-http-proxy-uri</tt><ttclass="descclassname">=<URI></tt><aclass="headerlink"href="#cmdoption-nghttpx--backend-http-proxy-uri"title="Permalink to this definition">¶</a></dt>
<dd><p>Specify proxy URI in the form
<aclass="reference external"href="http:/">http:/</a>/[<USER>:<PASS>@]<PROXY>:<PORT>. If a
proxy requires authentication, specify <USER> and
<PASS>. Note that they must be properly
percent-encoded. This proxy is used when the
backend connection is HTTP/2. First, make a
CONNECT request to the proxy and it connects to
the backend on behalf of nghttpx. This forms
tunnel. After that, nghttpx performs SSL/TLS
handshake with the downstream through the tunnel.
The timeouts when connecting and making CONNECT
request can be specified by
<aclass="reference internal"href="#cmdoption-nghttpx--backend-read-timeout"><emclass="xref std std-option">--backend-read-timeout</em></a> and
<h3>Performance<aclass="headerlink"href="#performance"title="Permalink to this headline">¶</a></h3>
<dlclass="option">
<dtid="cmdoption-nghttpx-n">
<spanid="cmdoption-nghttpx--workers"></span><ttclass="descname">-n</tt><ttclass="descclassname"></tt><ttclass="descclassname">, </tt><ttclass="descname">--workers</tt><ttclass="descclassname">=<CORES></tt><aclass="headerlink"href="#cmdoption-nghttpx-n"title="Permalink to this definition">¶</a></dt>
<ttclass="descname">--read-rate</tt><ttclass="descclassname">=<RATE></tt><aclass="headerlink"href="#cmdoption-nghttpx--read-rate"title="Permalink to this definition">¶</a></dt>
<dd><p>Set maximum average read rate on frontend
connection. Setting 0 to this option means read
rate is unlimited.
Default: 0</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-nghttpx--read-burst">
<ttclass="descname">--read-burst</tt><ttclass="descclassname">=<SIZE></tt><aclass="headerlink"href="#cmdoption-nghttpx--read-burst"title="Permalink to this definition">¶</a></dt>
<dd><p>Set maximum read burst size on frontend
connection. Setting 0 does not work, but it is
not a problem because –read-rate=0 will give
unlimited read rate regardless of this option
value.
Default: 1073741824</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-nghttpx--write-rate">
<ttclass="descname">--write-rate</tt><ttclass="descclassname">=<RATE></tt><aclass="headerlink"href="#cmdoption-nghttpx--write-rate"title="Permalink to this definition">¶</a></dt>
<dd><p>Set maximum average write rate on frontend
connection. Setting 0 to this option means write
rate is unlimited.
Default: 0</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-nghttpx--write-burst">
<ttclass="descname">--write-burst</tt><ttclass="descclassname">=<SIZE></tt><aclass="headerlink"href="#cmdoption-nghttpx--write-burst"title="Permalink to this definition">¶</a></dt>
<ttclass="descname">--worker-read-rate</tt><ttclass="descclassname">=<RATE></tt><aclass="headerlink"href="#cmdoption-nghttpx--worker-read-rate"title="Permalink to this definition">¶</a></dt>
<dd><p>Set maximum average read rate on frontend
connection per worker. Setting 0 to this option
means read rate is unlimited.
Default: 0</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-nghttpx--worker-read-burst">
<ttclass="descname">--worker-read-burst</tt><ttclass="descclassname">=<SIZE></tt><aclass="headerlink"href="#cmdoption-nghttpx--worker-read-burst"title="Permalink to this definition">¶</a></dt>
<dd><p>Set maximum read burst size on frontend
connection per worker. Setting 0 to this option
means read burst size is unlimited.
Default: 0</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-nghttpx--worker-write-rate">
<ttclass="descname">--worker-write-rate</tt><ttclass="descclassname">=<RATE></tt><aclass="headerlink"href="#cmdoption-nghttpx--worker-write-rate"title="Permalink to this definition">¶</a></dt>
<dd><p>Set maximum average write rate on frontend
connection per worker. Setting 0 to this option
means write rate is unlimited.
Default: 0</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-nghttpx--worker-write-burst">
<ttclass="descname">--worker-write-burst</tt><ttclass="descclassname">=<SIZE></tt><aclass="headerlink"href="#cmdoption-nghttpx--worker-write-burst"title="Permalink to this definition">¶</a></dt>
<ttclass="descname">--worker-frontend-connections</tt><ttclass="descclassname">=<NUM></tt><aclass="headerlink"href="#cmdoption-nghttpx--worker-frontend-connections"title="Permalink to this definition">¶</a></dt>
<dd><p>Set maximum number of simultaneous connections
<ttclass="descname">--backend-connections-per-frontend</tt><ttclass="descclassname">=<NUM></tt><aclass="headerlink"href="#cmdoption-nghttpx--backend-connections-per-frontend"title="Permalink to this definition">¶</a></dt>
<ttclass="descname">--frontend-http2-read-timeout</tt><ttclass="descclassname">=<SEC></tt><aclass="headerlink"href="#cmdoption-nghttpx--frontend-http2-read-timeout"title="Permalink to this definition">¶</a></dt>
<dd><p>Specify read timeout for HTTP/2 and SPDY frontend
connection.
Default: 180</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-nghttpx--frontend-read-timeout">
<ttclass="descname">--frontend-read-timeout</tt><ttclass="descclassname">=<SEC></tt><aclass="headerlink"href="#cmdoption-nghttpx--frontend-read-timeout"title="Permalink to this definition">¶</a></dt>
<ttclass="descname">--frontend-write-timeout</tt><ttclass="descclassname">=<SEC></tt><aclass="headerlink"href="#cmdoption-nghttpx--frontend-write-timeout"title="Permalink to this definition">¶</a></dt>
<ttclass="descname">--stream-read-timeout</tt><ttclass="descclassname">=<SEC></tt><aclass="headerlink"href="#cmdoption-nghttpx--stream-read-timeout"title="Permalink to this definition">¶</a></dt>
<dd><p>Specify read timeout for HTTP/2 and SPDY streams.
0 means no timeout.
Default: 0</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-nghttpx--stream-write-timeout">
<ttclass="descname">--stream-write-timeout</tt><ttclass="descclassname">=<SEC></tt><aclass="headerlink"href="#cmdoption-nghttpx--stream-write-timeout"title="Permalink to this definition">¶</a></dt>
<ttclass="descname">--backend-read-timeout</tt><ttclass="descclassname">=<SEC></tt><aclass="headerlink"href="#cmdoption-nghttpx--backend-read-timeout"title="Permalink to this definition">¶</a></dt>
<dd><p>Specify read timeout for backend connection.
<ttclass="descname">--backend-write-timeout</tt><ttclass="descclassname">=<SEC></tt><aclass="headerlink"href="#cmdoption-nghttpx--backend-write-timeout"title="Permalink to this definition">¶</a></dt>
<dd><p>Specify write timeout for backend connection.
<ttclass="descname">--backend-keep-alive-timeout</tt><ttclass="descclassname">=<SEC></tt><aclass="headerlink"href="#cmdoption-nghttpx--backend-keep-alive-timeout"title="Permalink to this definition">¶</a></dt>
<ttclass="descname">--listener-disable-timeout</tt><ttclass="descclassname">=<SEC></tt><aclass="headerlink"href="#cmdoption-nghttpx--listener-disable-timeout"title="Permalink to this definition">¶</a></dt>
<h3>SSL/TLS<aclass="headerlink"href="#ssl-tls"title="Permalink to this headline">¶</a></h3>
<dlclass="option">
<dtid="cmdoption-nghttpx--ciphers">
<ttclass="descname">--ciphers</tt><ttclass="descclassname">=<SUITE></tt><aclass="headerlink"href="#cmdoption-nghttpx--ciphers"title="Permalink to this definition">¶</a></dt>
<dd><p>Set allowed cipher list. The format of the
string is described in OpenSSL ciphers(1).</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-nghttpx-k">
<spanid="cmdoption-nghttpx--insecure"></span><ttclass="descname">-k</tt><ttclass="descclassname"></tt><ttclass="descclassname">, </tt><ttclass="descname">--insecure</tt><ttclass="descclassname"></tt><aclass="headerlink"href="#cmdoption-nghttpx-k"title="Permalink to this definition">¶</a></dt>
<dd><p>Don’t verify backend server’s certificate if <aclass="reference internal"href="#cmdoption-nghttpx-p"><emclass="xref std std-option">-p</em></a>,
<aclass="reference internal"href="#cmdoption-nghttpx--client"><emclass="xref std std-option">--client</em></a> or <aclass="reference internal"href="#cmdoption-nghttpx--http2-bridge"><emclass="xref std std-option">--http2-bridge</em></a> are given and
<aclass="reference internal"href="#cmdoption-nghttpx--backend-no-tls"><emclass="xref std std-option">--backend-no-tls</em></a> is not given.</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-nghttpx--cacert">
<ttclass="descname">--cacert</tt><ttclass="descclassname">=<PATH></tt><aclass="headerlink"href="#cmdoption-nghttpx--cacert"title="Permalink to this definition">¶</a></dt>
<dd><p>Set path to trusted CA certificate file if <aclass="reference internal"href="#cmdoption-nghttpx-p"><emclass="xref std std-option">-p</em></a>,
<aclass="reference internal"href="#cmdoption-nghttpx--client"><emclass="xref std std-option">--client</em></a> or <aclass="reference internal"href="#cmdoption-nghttpx--http2-bridge"><emclass="xref std std-option">--http2-bridge</em></a> are given and
<aclass="reference internal"href="#cmdoption-nghttpx--backend-no-tls"><emclass="xref std std-option">--backend-no-tls</em></a> is not given. The file must be
in PEM format. It can contain multiple
certificates. If the linked OpenSSL is
configured to load system wide certificates, they
are loaded at startup regardless of this option.</p>
<ttclass="descname">--private-key-passwd-file</tt><ttclass="descclassname">=<FILEPATH></tt><aclass="headerlink"href="#cmdoption-nghttpx--private-key-passwd-file"title="Permalink to this definition">¶</a></dt>
<dd><p>Path to file that contains password for the
server’s private key. If none is given and the
private key is password protected it’ll be
requested interactively.</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-nghttpx--subcert">
<ttclass="descname">--subcert</tt><ttclass="descclassname">=<KEYPATH>:<CERTPATH></tt><aclass="headerlink"href="#cmdoption-nghttpx--subcert"title="Permalink to this definition">¶</a></dt>
<dd><p>Specify additional certificate and private key
file. nghttpx will choose certificates based on
the hostname indicated by client using TLS SNI
extension. This option can be used multiple
times.</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-nghttpx--backend-tls-sni-field">
<ttclass="descname">--backend-tls-sni-field</tt><ttclass="descclassname">=<HOST></tt><aclass="headerlink"href="#cmdoption-nghttpx--backend-tls-sni-field"title="Permalink to this definition">¶</a></dt>
<dd><p>Explicitly set the content of the TLS SNI
extension. This will default to the backend HOST
name.</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-nghttpx--dh-param-file">
<ttclass="descname">--dh-param-file</tt><ttclass="descclassname">=<PATH></tt><aclass="headerlink"href="#cmdoption-nghttpx--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>
<dlclass="option">
<dtid="cmdoption-nghttpx--npn-list">
<ttclass="descname">--npn-list</tt><ttclass="descclassname">=<LIST></tt><aclass="headerlink"href="#cmdoption-nghttpx--npn-list"title="Permalink to this definition">¶</a></dt>
<dd><p>Comma delimited list of ALPN protocol identifier
<ttclass="descname">--verify-client</tt><ttclass="descclassname"></tt><aclass="headerlink"href="#cmdoption-nghttpx--verify-client"title="Permalink to this definition">¶</a></dt>
<dd><p>Require and verify client certificate.</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-nghttpx--verify-client-cacert">
<ttclass="descname">--verify-client-cacert</tt><ttclass="descclassname">=<PATH></tt><aclass="headerlink"href="#cmdoption-nghttpx--verify-client-cacert"title="Permalink to this definition">¶</a></dt>
<dd><p>Path to file that contains CA certificates to
<ttclass="descname">--client-private-key-file</tt><ttclass="descclassname">=<PATH></tt><aclass="headerlink"href="#cmdoption-nghttpx--client-private-key-file"title="Permalink to this definition">¶</a></dt>
<dd><p>Path to file that contains client private key
used in backend client authentication.</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-nghttpx--client-cert-file">
<ttclass="descname">--client-cert-file</tt><ttclass="descclassname">=<PATH></tt><aclass="headerlink"href="#cmdoption-nghttpx--client-cert-file"title="Permalink to this definition">¶</a></dt>
<dd><p>Path to file that contains client certificate
used in backend client authentication.</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-nghttpx--tls-proto-list">
<ttclass="descname">--tls-proto-list</tt><ttclass="descclassname">=<LIST></tt><aclass="headerlink"href="#cmdoption-nghttpx--tls-proto-list"title="Permalink to this definition">¶</a></dt>
<dd><p>Comma delimited list of SSL/TLS protocol to be
enabled. The following protocols are available:
TLSv1.2, TLSv1.1, TLSv1.0 and SSLv3. The name
matching is done in case-insensitive manner. The
parameter must be delimited by a single comma
only and any white spaces are treated as a part
of protocol string.
Default: TLSv1.2,TLSv1.1</p>
</dd></dl>
</div>
<divclass="section"id="http-2-and-spdy">
<h3>HTTP/2 and SPDY<aclass="headerlink"href="#http-2-and-spdy"title="Permalink to this headline">¶</a></h3>
<dlclass="option">
<dtid="cmdoption-nghttpx-c">
<spanid="cmdoption-nghttpx--http2-max-concurrent-streams"></span><ttclass="descname">-c</tt><ttclass="descclassname"></tt><ttclass="descclassname">, </tt><ttclass="descname">--http2-max-concurrent-streams</tt><ttclass="descclassname">=<NUM></tt><aclass="headerlink"href="#cmdoption-nghttpx-c"title="Permalink to this definition">¶</a></dt>
<dd><p>Set the maximum number of the concurrent streams
<ttclass="descname">--frontend-http2-window-bits</tt><ttclass="descclassname">=<N></tt><aclass="headerlink"href="#cmdoption-nghttpx--frontend-http2-window-bits"title="Permalink to this definition">¶</a></dt>
<dd><p>Sets the per-stream initial window size of HTTP/2
SPDY frontend connection. For HTTP/2, the size
is 2**<N>-1. For SPDY, the size is 2**<N>.
<ttclass="descname">--frontend-http2-connection-window-bits</tt><ttclass="descclassname">=<N></tt><aclass="headerlink"href="#cmdoption-nghttpx--frontend-http2-connection-window-bits"title="Permalink to this definition">¶</a></dt>
<dd><p>Sets the per-connection window size of HTTP/2 and
SPDY frontend connection. For HTTP/2, the size
is 2**<N>-1. For SPDY, the size is 2**<N>.
Default: 16</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-nghttpx--frontend-no-tls">
<ttclass="descname">--frontend-no-tls</tt><ttclass="descclassname"></tt><aclass="headerlink"href="#cmdoption-nghttpx--frontend-no-tls"title="Permalink to this definition">¶</a></dt>
<dd><p>Disable SSL/TLS on frontend connections.</p>
<ttclass="descname">--backend-http2-window-bits</tt><ttclass="descclassname">=<N></tt><aclass="headerlink"href="#cmdoption-nghttpx--backend-http2-window-bits"title="Permalink to this definition">¶</a></dt>
<dd><p>Sets the initial window size of HTTP/2 backend
<ttclass="descname">--backend-http2-connection-window-bits</tt><ttclass="descclassname">=<N></tt><aclass="headerlink"href="#cmdoption-nghttpx--backend-http2-connection-window-bits"title="Permalink to this definition">¶</a></dt>
<dd><p>Sets the per-connection window size of HTTP/2
backend connection to 2**<N>-1.
Default: 16</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-nghttpx--backend-no-tls">
<ttclass="descname">--backend-no-tls</tt><ttclass="descclassname"></tt><aclass="headerlink"href="#cmdoption-nghttpx--backend-no-tls"title="Permalink to this definition">¶</a></dt>
<dd><p>Disable SSL/TLS on backend connections.</p>
<ttclass="descname">--http2-no-cookie-crumbling</tt><ttclass="descclassname"></tt><aclass="headerlink"href="#cmdoption-nghttpx--http2-no-cookie-crumbling"title="Permalink to this definition">¶</a></dt>
<ttclass="descname">--padding</tt><ttclass="descclassname">=<N></tt><aclass="headerlink"href="#cmdoption-nghttpx--padding"title="Permalink to this definition">¶</a></dt>
<dd><p>Add at most <N> bytes to a HTTP/2 frame payload
as padding. Specify 0 to disable padding. This
option is meant for debugging purpose and not
intended to enhance protocol security.</p>
</dd></dl>
</div>
<divclass="section"id="mode">
<h3>Mode<aclass="headerlink"href="#mode"title="Permalink to this headline">¶</a></h3>
<dlclass="describe">
<dt>
<ttclass="descname">(default mode)</tt></dt>
<dd><p>Accept HTTP/2, SPDY and HTTP/1.1 over SSL/TLS.
If <aclass="reference internal"href="#cmdoption-nghttpx--frontend-no-tls"><emclass="xref std std-option">--frontend-no-tls</em></a> is used, accept HTTP/2 and
HTTP/1.1. The incoming HTTP/1.1 connection can
be upgraded to HTTP/2 through HTTP Upgrade. The
protocol to the backend is HTTP/1.1.</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-nghttpx-s">
<spanid="cmdoption-nghttpx--http2-proxy"></span><ttclass="descname">-s</tt><ttclass="descclassname"></tt><ttclass="descclassname">, </tt><ttclass="descname">--http2-proxy</tt><ttclass="descclassname"></tt><aclass="headerlink"href="#cmdoption-nghttpx-s"title="Permalink to this definition">¶</a></dt>
<dd><p>Like default mode, but enable secure proxy mode.</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-nghttpx--http2-bridge">
<ttclass="descname">--http2-bridge</tt><ttclass="descclassname"></tt><aclass="headerlink"href="#cmdoption-nghttpx--http2-bridge"title="Permalink to this definition">¶</a></dt>
<dd><p>Like default mode, but communicate with the
backend in HTTP/2 over SSL/TLS. Thus the
incoming all connections are converted to HTTP/2
connection and relayed to the backend. See
<aclass="reference internal"href="#cmdoption-nghttpx--backend-http-proxy-uri"><emclass="xref std std-option">--backend-http-proxy-uri</em></a> option if you are behind
the proxy and want to connect to the outside
HTTP/2 proxy.</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-nghttpx--client">
<ttclass="descname">--client</tt><ttclass="descclassname"></tt><aclass="headerlink"href="#cmdoption-nghttpx--client"title="Permalink to this definition">¶</a></dt>
<dd><p>Accept HTTP/2 and HTTP/1.1 without SSL/TLS. The
incoming HTTP/1.1 connection can be upgraded to
HTTP/2 connection through HTTP Upgrade. The
protocol to the backend is HTTP/2. To use
nghttpx as a forward proxy, use <aclass="reference internal"href="#cmdoption-nghttpx-p"><emclass="xref std std-option">-p</em></a> option
instead.</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-nghttpx-p">
<spanid="cmdoption-nghttpx--client-proxy"></span><ttclass="descname">-p</tt><ttclass="descclassname"></tt><ttclass="descclassname">, </tt><ttclass="descname">--client-proxy</tt><ttclass="descclassname"></tt><aclass="headerlink"href="#cmdoption-nghttpx-p"title="Permalink to this definition">¶</a></dt>
<dd><p>Like <aclass="reference internal"href="#cmdoption-nghttpx--client"><emclass="xref std std-option">--client</em></a> option, but it also requires the
request path from frontend must be an absolute
URI, suitable for use as a forward proxy.</p>
</dd></dl>
</div>
<divclass="section"id="logging">
<h3>Logging<aclass="headerlink"href="#logging"title="Permalink to this headline">¶</a></h3>
<dlclass="option">
<dtid="cmdoption-nghttpx-L">
<spanid="cmdoption-nghttpx--log-level"></span><ttclass="descname">-L</tt><ttclass="descclassname"></tt><ttclass="descclassname">, </tt><ttclass="descname">--log-level</tt><ttclass="descclassname">=<LEVEL></tt><aclass="headerlink"href="#cmdoption-nghttpx-L"title="Permalink to this definition">¶</a></dt>
<dd><p>Set the severity level of log output. <LEVEL>
must be one of INFO, WARNING, ERROR and FATAL.
Default: WARNING</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-nghttpx--accesslog-file">
<ttclass="descname">--accesslog-file</tt><ttclass="descclassname">=<PATH></tt><aclass="headerlink"href="#cmdoption-nghttpx--accesslog-file"title="Permalink to this definition">¶</a></dt>
<dd><p>Set path to write access log. To reopen file,
send USR1 signal to nghttpx.</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-nghttpx--accesslog-syslog">
<ttclass="descname">--accesslog-syslog</tt><ttclass="descclassname"></tt><aclass="headerlink"href="#cmdoption-nghttpx--accesslog-syslog"title="Permalink to this definition">¶</a></dt>
<dd><p>Send access log to syslog. If this option is
used, <emclass="xref std std-option">--access-file</em> option is ignored.</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-nghttpx--errorlog-file">
<ttclass="descname">--errorlog-file</tt><ttclass="descclassname">=<PATH></tt><aclass="headerlink"href="#cmdoption-nghttpx--errorlog-file"title="Permalink to this definition">¶</a></dt>
<dd><p>Set path to write error log. To reopen file,
send USR1 signal to nghttpx.
Default: /dev/stderr</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-nghttpx--errorlog-syslog">
<ttclass="descname">--errorlog-syslog</tt><ttclass="descclassname"></tt><aclass="headerlink"href="#cmdoption-nghttpx--errorlog-syslog"title="Permalink to this definition">¶</a></dt>
<dd><p>Send error log to syslog. If this option is
used, <aclass="reference internal"href="#cmdoption-nghttpx--errorlog-file"><emclass="xref std std-option">--errorlog-file</em></a> option is ignored.</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-nghttpx--syslog-facility">
<ttclass="descname">--syslog-facility</tt><ttclass="descclassname">=<FACILITY></tt><aclass="headerlink"href="#cmdoption-nghttpx--syslog-facility"title="Permalink to this definition">¶</a></dt>
<dd><p>Set syslog facility to <FACILITY>.
Default: daemon</p>
</dd></dl>
</div>
<divclass="section"id="misc">
<h3>Misc<aclass="headerlink"href="#misc"title="Permalink to this headline">¶</a></h3>
<dlclass="option">
<dtid="cmdoption-nghttpx--add-x-forwarded-for">
<ttclass="descname">--add-x-forwarded-for</tt><ttclass="descclassname"></tt><aclass="headerlink"href="#cmdoption-nghttpx--add-x-forwarded-for"title="Permalink to this definition">¶</a></dt>
<dd><p>Append X-Forwarded-For header field to the
downstream request.</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-nghttpx--no-via">
<ttclass="descname">--no-via</tt><ttclass="descclassname"></tt><aclass="headerlink"href="#cmdoption-nghttpx--no-via"title="Permalink to this definition">¶</a></dt>
<dd><p>Don’t append to Via header field. If Via header
<ttclass="descname">--no-location-rewrite</tt><ttclass="descclassname"></tt><aclass="headerlink"href="#cmdoption-nghttpx--no-location-rewrite"title="Permalink to this definition">¶</a></dt>
<dd><p>Don’t rewrite location header field on
<aclass="reference internal"href="#cmdoption-nghttpx--http2-bridge"><emclass="xref std std-option">--http2-bridge</em></a>, <aclass="reference internal"href="#cmdoption-nghttpx--client"><emclass="xref std std-option">--client</em></a> and default mode. For
<ttclass="descname">--altsvc</tt><ttclass="descclassname">=<PROTOID,PORT[,HOST,[ORIGIN]]></tt><aclass="headerlink"href="#cmdoption-nghttpx--altsvc"title="Permalink to this definition">¶</a></dt>
<dd><p>Specify protocol ID, port, host and origin of
alternative service. <HOST> and <ORIGIN> are
optional. They are advertised in alt-svc header
field or HTTP/2 ALTSVC frame. This option can be
used multiple times to specify multiple
alternative services. Example: –altsvc=h2,443</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-nghttpx--add-response-header">
<ttclass="descname">--add-response-header</tt><ttclass="descclassname">=<HEADER></tt><aclass="headerlink"href="#cmdoption-nghttpx--add-response-header"title="Permalink to this definition">¶</a></dt>
<dd><p>Specify additional header field to add to
response header set. This option just appends
header field and won’t replace anything already
<ttclass="descname">--frontend-http2-dump-request-header</tt><ttclass="descclassname">=<PATH></tt><aclass="headerlink"href="#cmdoption-nghttpx--frontend-http2-dump-request-header"title="Permalink to this definition">¶</a></dt>
<dd><p>Dumps request headers received by HTTP/2 frontend
to the file denoted in <PATH>. The output is
done in HTTP/1 header field format and each
header block is followed by an empty line. This
option is not thread safe and MUST NOT be used
with option -n<N>, where <N>>= 2.</p>
<ttclass="descname">--frontend-http2-dump-response-header</tt><ttclass="descclassname">=<PATH></tt><aclass="headerlink"href="#cmdoption-nghttpx--frontend-http2-dump-response-header"title="Permalink to this definition">¶</a></dt>
<dd><p>Dumps response headers sent from HTTP/2 frontend
to the file denoted in <PATH>. The output is
done in HTTP/1 header field format and each
header block is followed by an empty line. This
option is not thread safe and MUST NOT be used
with option -n<N>, where <N>>= 2.</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-nghttpx-o">
<spanid="cmdoption-nghttpx--frontend-frame-debug"></span><ttclass="descname">-o</tt><ttclass="descclassname"></tt><ttclass="descclassname">, </tt><ttclass="descname">--frontend-frame-debug</tt><ttclass="descclassname"></tt><aclass="headerlink"href="#cmdoption-nghttpx-o"title="Permalink to this definition">¶</a></dt>
<dd><p>Print HTTP/2 frames in frontend to stderr. This
option is not thread safe and MUST NOT be used
with option -n=N, where N >= 2.</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-nghttpx-D">
<spanid="cmdoption-nghttpx--daemon"></span><ttclass="descname">-D</tt><ttclass="descclassname"></tt><ttclass="descclassname">, </tt><ttclass="descname">--daemon</tt><ttclass="descclassname"></tt><aclass="headerlink"href="#cmdoption-nghttpx-D"title="Permalink to this definition">¶</a></dt>
<dd><p>Run in a background. If <aclass="reference internal"href="#cmdoption-nghttpx-D"><emclass="xref std std-option">-D</em></a> is used, the current
working directory is changed to ‘/’.</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-nghttpx--pid-file">
<ttclass="descname">--pid-file</tt><ttclass="descclassname">=<PATH></tt><aclass="headerlink"href="#cmdoption-nghttpx--pid-file"title="Permalink to this definition">¶</a></dt>
<dd><p>Set path to save PID of this program.</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-nghttpx--user">
<ttclass="descname">--user</tt><ttclass="descclassname">=<USER></tt><aclass="headerlink"href="#cmdoption-nghttpx--user"title="Permalink to this definition">¶</a></dt>
<dd><p>Run this program as <USER>. This option is
intended to be used to drop root privileges.</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-nghttpx--conf">
<ttclass="descname">--conf</tt><ttclass="descclassname">=<PATH></tt><aclass="headerlink"href="#cmdoption-nghttpx--conf"title="Permalink to this definition">¶</a></dt>
<dd><p>Load configuration from <PATH>.
Default: /etc/nghttpx/nghttpx.conf</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-nghttpx-v">
<spanid="cmdoption-nghttpx--version"></span><ttclass="descname">-v</tt><ttclass="descclassname"></tt><ttclass="descclassname">, </tt><ttclass="descname">--version</tt><ttclass="descclassname"></tt><aclass="headerlink"href="#cmdoption-nghttpx-v"title="Permalink to this definition">¶</a></dt>
<dd><p>Print version and exit.</p>
</dd></dl>
<dlclass="option">
<dtid="cmdoption-nghttpx-h">
<spanid="cmdoption-nghttpx--help"></span><ttclass="descname">-h</tt><ttclass="descclassname"></tt><ttclass="descclassname">, </tt><ttclass="descname">--help</tt><ttclass="descclassname"></tt><aclass="headerlink"href="#cmdoption-nghttpx-h"title="Permalink to this definition">¶</a></dt>
<dd><p>Print this help and exit.</p>
</dd></dl>
</div>
</div>
<divclass="section"id="see-also">
<h2>SEE ALSO<aclass="headerlink"href="#see-also"title="Permalink to this headline">¶</a></h2>
