File: C:/Ruby27-x64/share/doc/ruby/html/WEBrick/Config.html
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>module WEBrick::Config - RDoc Documentation</title>
<script type="text/javascript">
var rdoc_rel_prefix = "../";
var index_rel_prefix = "../";
</script>
<script src="../js/navigation.js" defer></script>
<script src="../js/search.js" defer></script>
<script src="../js/search_index.js" defer></script>
<script src="../js/searcher.js" defer></script>
<script src="../js/darkfish.js" defer></script>
<link href="../css/fonts.css" rel="stylesheet">
<link href="../css/rdoc.css" rel="stylesheet">
<body id="top" role="document" class="module">
<nav role="navigation">
<div id="project-navigation">
<div id="home-section" role="region" title="Quick navigation" class="nav-section">
<h2>
<a href="../index.html" rel="home">Home</a>
</h2>
<div id="table-of-contents-navigation">
<a href="../table_of_contents.html#pages">Pages</a>
<a href="../table_of_contents.html#classes">Classes</a>
<a href="../table_of_contents.html#methods">Methods</a>
</div>
</div>
<div id="search-section" role="search" class="project-section initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
<div id="search-field-wrapper">
<input id="search-field" role="combobox" aria-label="Search"
aria-autocomplete="list" aria-controls="search-results"
type="text" name="search" placeholder="Search" spellcheck="false"
title="Type to search, Up and Down to navigate, Enter to load">
</div>
<ul id="search-results" aria-label="Search Results"
aria-busy="false" aria-expanded="false"
aria-atomic="false" class="initially-hidden"></ul>
</form>
</div>
</div>
<div id="class-metadata">
</div>
</nav>
<main role="main" aria-labelledby="module-WEBrick::Config">
<h1 id="module-WEBrick::Config" class="module">
module WEBrick::Config
</h1>
<section class="description">
</section>
<section id="5Buntitled-5D" class="documentation-section">
<section class="constants-list">
<header>
<h3>Constants</h3>
</header>
<dl>
<dt id="BasicAuth">BasicAuth
<dd><p>Default configuration for <a href="HTTPAuth/BasicAuth.html"><code>WEBrick::HTTPAuth::BasicAuth</code></a></p>
<dl class="rdoc-list note-list"><dt>:AutoReloadUserDB
<dd>
<p>Reload the user database provided by :UserDB automatically?</p>
</dd></dl>
<dt id="DigestAuth">DigestAuth
<dd><p>Default configuration for <a href="HTTPAuth/DigestAuth.html"><code>WEBrick::HTTPAuth::DigestAuth</code></a>.</p>
<dl class="rdoc-list note-list"><dt>:Algorithm
<dd>
<p>MD5, MD5-sess (default), SHA1, SHA1-sess</p>
</dd><dt>:Domain
<dd>
<p>An <a href="../Array.html"><code>Array</code></a> of URIs that define the protected space</p>
</dd><dt>:Qop
<dd>
<p>'auth' for authentication, 'auth-int' for integrity protection or both</p>
</dd><dt>:UseOpaque
<dd>
<p>Should the server send opaque values to the client? This helps prevent replay attacks.</p>
</dd><dt>:CheckNc
<dd>
<p>Should the server check the nonce count? This helps the server detect replay attacks.</p>
</dd><dt>:UseAuthenticationInfoHeader
<dd>
<p>Should the server send an AuthenticationInfo header?</p>
</dd><dt>:AutoReloadUserDB
<dd>
<p>Reload the user database provided by :UserDB automatically?</p>
</dd><dt>:NonceExpirePeriod
<dd>
<p>How long should we store used nonces? Default is 30 minutes.</p>
</dd><dt>:NonceExpireDelta
<dd>
<p>How long is a nonce valid? Default is 1 minute</p>
</dd><dt>:InternetExplorerHack
<dd>
<p>Hack which allows Internet Explorer to work.</p>
</dd><dt>:OperaHack
<dd>
<p>Hack which allows Opera to work.</p>
</dd></dl>
<dt id="FileHandler">FileHandler
<dd><p>Default configuration for <a href="HTTPServlet/FileHandler.html"><code>WEBrick::HTTPServlet::FileHandler</code></a></p>
<dl class="rdoc-list note-list"><dt>:AcceptableLanguages
<dd>
<p><a href="../Array.html"><code>Array</code></a> of languages allowed for accept-language. There is no default</p>
</dd><dt>:DirectoryCallback
<dd>
<p>Allows preprocessing of directory requests. There is no default callback.</p>
</dd><dt>:FancyIndexing
<dd>
<p>If true, show an index for directories. The default is true.</p>
</dd><dt>:FileCallback
<dd>
<p>Allows preprocessing of file requests. There is no default callback.</p>
</dd><dt>:HandlerCallback
<dd>
<p>Allows preprocessing of requests. There is no default callback.</p>
</dd><dt>:HandlerTable
<dd>
<p>Maps file suffixes to file handlers. DefaultFileHandler is used by default but any servlet can be used.</p>
</dd><dt>:NondisclosureName
<dd>
<p>Do not show files matching this array of globs. .ht* and *~ are excluded by default.</p>
</dd><dt>:UserDir
<dd>
<p>Directory inside ~user to serve content from for /~user requests. Only works if mounted on /. Disabled by default.</p>
</dd></dl>
<dt id="General">General
<dd><p>for <a href="GenericServer.html"><code>GenericServer</code></a></p>
<dt id="HTTP">HTTP
<dd><p>for <a href="HTTPServer.html"><code>HTTPServer</code></a>, <a href="HTTPRequest.html"><code>HTTPRequest</code></a>, <a href="HTTPResponse.html"><code>HTTPResponse</code></a> …</p>
<dt id="SSL">SSL
<dd><p>Default <a href="Config.html#SSL"><code>SSL</code></a> server configuration.</p>
<p><a href="../WEBrick.html"><code>WEBrick</code></a> can automatically create a self-signed certificate if <code>:SSLCertName</code> is set. For more information on the various <a href="Config.html#SSL"><code>SSL</code></a> options see <a href="../OpenSSL/SSL/SSLContext.html"><code>OpenSSL::SSL::SSLContext</code></a>.</p>
<dl class="rdoc-list note-list"><dt>:ServerSoftware
<dd>
<p>The server software name used in the Server: header.</p>
</dd><dt>:SSLEnable
<dd>
<p>false,</p>
</dd></dl>
<pre>Enable SSL for this server. Defaults to false.</pre>
<dl class="rdoc-list note-list"><dt>:SSLCertificate
<dd>
<p>The <a href="Config.html#SSL"><code>SSL</code></a> certificate for the server.</p>
</dd><dt>:SSLPrivateKey
<dd>
<p>The <a href="Config.html#SSL"><code>SSL</code></a> private key for the server certificate.</p>
</dd><dt>:SSLClientCA
<dd>
<p>nil,</p>
</dd></dl>
<pre>Array of certificates that will be sent to the client.</pre>
<dl class="rdoc-list note-list"><dt>:SSLExtraChainCert
<dd>
<p>nil,</p>
</dd></dl>
<pre class="ruby"><span class="ruby-constant">Array</span> <span class="ruby-identifier">of</span> <span class="ruby-identifier">certificates</span> <span class="ruby-identifier">that</span> <span class="ruby-identifier">will</span> <span class="ruby-identifier">be</span> <span class="ruby-identifier">added</span> <span class="ruby-identifier">to</span> <span class="ruby-identifier">the</span> <span class="ruby-identifier">certificate</span> <span class="ruby-identifier">chain</span>
</pre>
<dl class="rdoc-list note-list"><dt>:SSLCACertificateFile
<dd>
<p>nil,</p>
</dd></dl>
<pre class="ruby"><span class="ruby-constant">Path</span> <span class="ruby-identifier">to</span> <span class="ruby-identifier">a</span> <span class="ruby-constant">CA</span> <span class="ruby-identifier">certificate</span> <span class="ruby-identifier">file</span>
</pre>
<dl class="rdoc-list note-list"><dt>:SSLCACertificatePath
<dd>
<p>nil,</p>
</dd></dl>
<pre class="ruby"><span class="ruby-constant">Path</span> <span class="ruby-identifier">to</span> <span class="ruby-identifier">a</span> <span class="ruby-identifier">directory</span> <span class="ruby-identifier">containing</span> <span class="ruby-constant">CA</span> <span class="ruby-identifier">certificates</span>
</pre>
<dl class="rdoc-list note-list"><dt>:SSLCertificateStore
<dd>
<p>nil,</p>
</dd></dl>
<pre>OpenSSL::X509::Store used for certificate validation of the client</pre>
<dl class="rdoc-list note-list"><dt>:SSLTmpDhCallback
<dd>
<p>nil,</p>
</dd></dl>
<pre>Callback invoked when DH parameters are required.</pre>
<dl class="rdoc-list note-list"><dt>:SSLVerifyClient
<dd>
<p>Sets whether the client is verified. This defaults to VERIFY_NONE which is typical for an HTTPS server.</p>
</dd><dt>:SSLVerifyDepth
<dd>
<p>Number of CA certificates to walk when verifying a certificate chain</p>
</dd><dt>:SSLVerifyCallback
<dd>
<p>Custom certificate verification callback</p>
</dd><dt>:SSLServerNameCallback
<dd>
<p>Custom servername indication callback</p>
</dd><dt>:SSLTimeout
<dd>
<p>Maximum session lifetime</p>
</dd><dt>:SSLOptions
<dd>
<p>Various <a href="Config.html#SSL"><code>SSL</code></a> options</p>
</dd><dt>:SSLCiphers
<dd>
<p>Ciphers to be used</p>
</dd><dt>:SSLStartImmediately
<dd>
<p>Immediately start <a href="Config.html#SSL"><code>SSL</code></a> upon connection? Defaults to true</p>
</dd><dt>:SSLCertName
<dd>
<p><a href="Config.html#SSL"><code>SSL</code></a> certificate name. Must be set to enable automatic certificate creation.</p>
</dd><dt>:SSLCertComment
<dd>
<p>Comment used during automatic certificate creation.</p>
</dd></dl>
</dl>
</section>
</section>
</main>
<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.2.1.1.
<p>Based on <a href="http://deveiate.org/projects/Darkfish-RDoc/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.
</footer>