<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<meta http-equiv="Content-type" content="text/html; charset=utf-8" />
<meta http-equiv="Content-Language" content="en-us" />
<meta name="ROBOTS" content="ALL" />
<meta http-equiv="imagetoolbar" content="no" />
<meta name="MSSmartTagsPreventParsing" content="true" />
<meta name="Keywords" content="cherokee web server httpd http" />
<meta name="Description" content="Cherokee is a flexible, very fast, lightweight Web server. It is implemented entirely in C, and has no dependencies beyond a standard C library. It is embeddable and extensible with plug-ins. It supports on-the-fly configuration by reading files or strings, TLS/SSL (via GNUTLS or OpenSSL), virtual hosts, authentication, cache friendly features, PHP, custom error management, and much more." />
<link href="media/css/cherokee_doc.css" rel="stylesheet" type="text/css" media="all" />
</head>
<body>
<h2 id="_a_href_index_html_index_a_8594_a_href_config_html_configuration_a"><a href="index.html">Index</a> → <a href="config.html">Configuration</a></h2>
<div class="sectionbody">
</div>
<h2 id="_general_configuration">General Configuration</h2>
<div class="sectionbody">
<h3 id="networking">Network</h3><div style="clear:left"></div>
<div class="imageblock">
<div class="content">
<img src="media/images/admin_general_networking.png" alt="media/images/admin_general_networking.png" />
</div>
<div class="image-title">Network settings</div>
</div>
<h4 id="_ipv6_support">IPv6 support</h4>
<div class="paragraph"><p>The IPv6 configuration key brings the possibility of activating or
deactivating the IPv6 support at the server. If Cherokee has been
compiled with IPv6 support (--with-ipv6), this configuration entry
will be fully functional, otherwise it will be ignored.</p></div>
<h4 id="_ssl_tls_back_end">SSL/TLS Back-end</h4>
<div class="paragraph"><p>Specifies the TLS/SSL backend to be used, if any. The current option
is OpenSSL.</p></div>
<h4 id="_timeout">Timeout</h4>
<div class="paragraph"><p>Sets the number of seconds that Cherokee will wait before closing the
connection.</p></div>
<h4 id="_server_tokens">Server Tokens</h4>
<div class="paragraph"><p>This specifies the string that Cherokee should use to identify
itself.</p></div>
<div class="tableblock">
<table rules="all"
width="100%"
frame="border"
cellspacing="0" cellpadding="4">
<col width="50%" />
<col width="50%" />
<thead>
<tr>
<th align="left" valign="top">Parameters </th>
<th align="left" valign="top">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td align="left" valign="top"><p class="table">Product</p></td>
<td align="left" valign="top"><p class="table">Cherokee</p></td>
</tr>
<tr>
<td align="left" valign="top"><p class="table">Minor</p></td>
<td align="left" valign="top"><p class="table">Cherokee/0.98</p></td>
</tr>
<tr>
<td align="left" valign="top"><p class="table">Minimal</p></td>
<td align="left" valign="top"><p class="table">Cherokee/0.98.3</p></td>
</tr>
<tr>
<td align="left" valign="top"><p class="table">OS</p></td>
<td align="left" valign="top"><p class="table">Cherokee/0.98.3 (UNIX)</p></td>
</tr>
<tr>
<td align="left" valign="top"><p class="table">Full</p></td>
<td align="left" valign="top"><p class="table">Cherokee/0.98.3 b2955 (UNIX)</p></td>
</tr>
</tbody>
</table>
</div>
<div class="paragraph"><p>By default, Cherokee will use <strong>Full</strong>.</p></div>
<h4 id="_graphs_type">Graphs type</h4>
<div class="paragraph"><p>Through this you can enable or disable the usage of RRD graphs. Check
the <a href="other_graphs.html">usage graphs</a> section for more details.</p></div>
<h3 id="ports_to_listen">Ports to listen</h3><div style="clear:left"></div>
<div class="imageblock">
<div class="content">
<img src="media/images/admin_general_ports.png" alt="media/images/admin_general_ports.png" />
</div>
<div class="image-title">Ports</div>
</div>
<div class="paragraph"><p>This section allows to configure the ports that the server will be
listening to. You can add several different ports, and configure
whether they will be used for HTTP or HTTPS.</p></div>
<div class="paragraph"><p>Each binding entry can be configured to listen to a network
interface. In case the text entry is empty, the server will accept
connections from that port on any interface.</p></div>
<h3 id="server_permissions">Server Permissions</h3><div style="clear:left"></div>
<div class="imageblock">
<div class="content">
<img src="media/images/admin_general_permissions.png" alt="media/images/admin_general_permissions.png" />
</div>
<div class="image-title">Permissions</div>
</div>
<h4 id="_user_amp_group">User & Group</h4>
<div class="paragraph"><p>The User directive configures which user the Cherokee daemon will
normally run as. By default, Cherokee runs as root which is considered
undesirable in all but the most trustful network configurations.</p></div>
<div class="paragraph"><p>The User directive used in conjunction with the Group directive
instructs the daemon to switch to the specified user and group as
quickly as possible after startup.</p></div>
<div class="paragraph"><p>There are two possible formats: using the user or group name, or using
the system ID.</p></div>
<h4 id="_chroot">Chroot</h4>
<div class="paragraph"><p>Cherokee can be jailed inside a directory. Note that this should not
be used as the sole security measure.</p></div>
<h3 id="icons">Icon management</h3><div style="clear:left"></div>
<div class="paragraph"><p>The icons configuration file associates an icon image with one or more
file extensions. This information will be used mainly by the
<a href="modules_handlers_dirlist.html">dirlist</a> handler.</p></div>
<div class="ulist"><ul>
<li>
<p>
<strong>Extensions</strong>
</p>
<div class="ulist"><ul>
<li>
<p>
This allows to associate icons with extensions.
</p>
</li>
</ul></div>
</li>
<li>
<p>
<strong>Files</strong>
</p>
<div class="ulist"><ul>
<li>
<p>
This section lets you specify an icon for certain filenames such
as "core" or "README". It accepts wild-card strings (using * and
?)
</p>
</li>
</ul></div>
</li>
<li>
<p>
<strong>Special icons</strong>
</p>
<div class="ulist"><ul>
<li>
<p>
<strong>Directory</strong>: In this case, it specifies the icon to be used
with Directories.
</p>
</li>
<li>
<p>
<strong>ParentDirectory</strong>: This entry is used to assign an Icon to the
"go to the parent directory" action.
</p>
</li>
<li>
<p>
<strong>Default</strong>: This is the icon that will be shown if any of the
previous ones matched.
</p>
</li>
</ul></div>
</li>
</ul></div>
<div class="imageblock">
<div class="content">
<img src="media/images/admin_general_icons.png" alt="media/images/admin_general_icons.png" />
</div>
<div class="image-title">Icons</div>
</div>
<h3 id="mime">MIME Types</h3><div style="clear:left"></div>
<div class="paragraph"><p>This section allows to add support for new MIME types or edit the
existing ones.</p></div>
<div class="ulist"><ul>
<li>
<p>
<strong>Mime Type</strong>: this is the proper mime string.
</p>
</li>
<li>
<p>
<strong>Extensions</strong>: the file extensions for this type of contents.
</p>
</li>
<li>
<p>
<strong>Max Age</strong>: defines for how long a file of this type must be cached at
the client’s side.
</p>
</li>
</ul></div>
<div class="imageblock">
<div class="content">
<img src="media/images/admin_general_mime.png" alt="media/images/admin_general_mime.png" />
</div>
<div class="image-title">MIME Types</div>
</div>
</div>
<div id="footer">
<div id="footer-text">
</div>
</div>
</body>
</html>
