This file is indexed.

/usr/share/doc/cherokee-doc/other_goodies.html is in cherokee-doc 1.2.101-1.

This file is owned by root:root, with mode 0o644.

The actual contents of the file can be viewed below.

  1
  2
  3
  4
  5
  6
  7
  8
  9
 10
 11
 12
 13
 14
 15
 16
 17
 18
 19
 20
 21
 22
 23
 24
 25
 26
 27
 28
 29
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
<!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_other_html_other_information_a"><a href="index.html">Index</a> &#8594; <a href="other.html">Other information</a></h2>
<div class="sectionbody">
</div>
<h2 id="_other_cherokee_goodies">Other: Cherokee goodies</h2>
<div class="sectionbody">
<div class="paragraph"><p>There are several important features of Cherokee that really do make a
difference in real-world production environments.</p></div>
<h3 id="cherokee-admin">Cherokee-Admin</h3><div style="clear:left"></div>
<div class="paragraph"><p>Cherokee bundles a one of a kind GUI to set up every available feature
without the need of editing any configuration files by hand. It is a
modern and easy to manage web application that allows to set up the
server with speed and ease. The interface is thoroughly documented
throughout Cherokee&#8217;s documentation. Several security measures prevent
non authorized personnel from accessing the application, and one-time
passwords are generated each time the program is launched. This can be
used to give temporary access to a remote administrator.</p></div>
<h3 id="cherokee-tweak">Cherokee-Tweak</h3><div style="clear:left"></div>
<div class="paragraph"><p>The Swiss-army knife of the Cherokee bundle. This little tool enables
you, among other things, to rotate the logs with absolutely no
downtime at all. No connections are lost. No delay happens. It can
also be used to trace Cherokee&#8217;s state on the fly, even remotely and
on production servers.</p></div>
<div class="paragraph"><p>This tool has its own documentation under the
<a href="other_bundle_cherokee-tweak.html">cherokee-tweak</a> section.</p></div>
<h3 id="x-sendfile">X-Sendfile</h3><div style="clear:left"></div>
<div class="paragraph"><p>X-Sendfile is a special, non-standard HTTP header that has been
supported by Cherokee for a while. At first you might think it is no
big deal, but think again.It can be enabled in any CGI, FastCGI, SCGI,
or uWSGI backend. Basically its job is to instruct the web server to
ignore the content of the response and replace it by whatever is
specified in the header. The main advantage of this is that it will be
Cherokee the one serving the file, making use of all its
optimizations. It is useful for processing script-output of e.g. php,
perl, ruby or any cgi.</p></div>
<div class="paragraph"><p>This is particularly useful because it hands the load to Cherokee, all
the response headers from the backend are forwarded, the whole
application uses a lot less resources and performs several times
faster not having to worry about a task best suited for a web server.</p></div>
<div class="paragraph"><p>You retain the ability to check for special privileges or dynamically
deciding anything contemplated by your backend&#8217;s logic, you speed up
things a lot while having more resources freed, and you can even
specify the delivery of files outside of the web server&#8217;s document
root path. Of course, this is to be done solely in controlled
environments. In short, it offers a huge performance gain at
absolutely no cost.</p></div>
<div class="paragraph"><p>Note that the X-Sendfile feature also supports <tt>X-Accel-Redirect</tt>
header, a similar feature offered by other web servers.
This is to allow the migration of applications supporting it without
having to make major code rewrites.</p></div>
<div class="paragraph"><p>Of course, this feature can be enabled or disabled in a per-rule
basis, so you can have several rules and handlers on your virtual
servers with the feature ON or OFF according to your needs.</p></div>
<h3 id="zero-downtime">Zero Downtime Updates, AKA "Graceful restart"</h3><div style="clear:left"></div>
<div class="paragraph"><p>Cherokee has an ability hardly ever seen in any service delivering
application, be it web content, multimedia streaming or almost any
other server you can think of.</p></div>
<div class="paragraph"><p>Whenever a configuration change is applied, it is immediately
reflected in the web server with no downtime requirements to restart
the server. Of course the connections that are already being served
will continue normally with the same parameters that where negotiated
with the requesting clients, but they will not be shut down just to
perform a menial task such as restarting the server.</p></div>
<div class="paragraph"><p>It&#8217;s a bit like changing the tires on your car while still driving.</p></div>
<div class="paragraph"><p>In fact, this mechanism is not only limited to configuration
updates. Cherokee is so smart that it can even apply this to perform
full program upgrades. This means you can completely replace the
binaries for new ones, launch the enhanced versions and yet not suffer
any downtime. Zero connection losses, no lag associated. Guaranteed.</p></div>
<div class="paragraph"><p>This might seem as just another cool feature, but is in fact
huge. Just think about it: an extremely high traffic site cannot
afford to be down. Ever. Not to upgrade the webserver. Not to enhance
it. Not to reflect a new configuration setting. Thousands of hits per
second depend on it.</p></div>
<div class="paragraph"><p>With Cherokee you can cope with this and much more. With Cherokee, it&#8217;s
easier done than said.</p></div>
<h3 id="ssl-vhosts">SSL Virtual Hosts</h3><div style="clear:left"></div>
<div class="paragraph"><p>A problem arises when virtual hosts and SSL must be used
simultaneously. This is due to the fact that a web server cannot see
the hostname header when the SSL request is being processed. The first
thing that the server has to do is to connect with the other end by
using SSL/TLS. The user entered host part of the URI must match the
Common Name (CN) provided by the certificate. Since virtual hosts are
in use, the CN of the first available certificate may or may not match
the one specified in the early stages of TLS negotiation.</p></div>
<div class="paragraph"><p>Cherokee supports the clean and standard method of dealing with this
issue called
<a href="http://en.wikipedia.org/wiki/Server_Name_Indication">Server Name
Indication</a> (SNI) that sends the name of the virtual host during the
TLS negotiation.</p></div>
<div class="paragraph"><p>If <a href="http://tools.ietf.org/html/rfc4366#section-3.1">SNI</a> is
supported by your SSL/TLS library, the SSL layer does not need to be
restarted. Since the host info can be put in the SSL handshake, things
will simply work as long as there is a web browser with SNI support at
the other side. Currently every modern web browser supports this, and
Cherokee has TLS SNI support for the OpenSSL backends.</p></div>
<div class="paragraph"><p>Note that for SNI to work, client support is required. Web browsers
known to support it are Mozilla Firefox 2.0+ and Opera 8.0+ in all its
variants, Safari 3.2.1+ on OS X and Vista, Internet Explorer 7+
(Vista, not XP) or later, and Google Chrome (Vista, not XP).</p></div>
<div class="paragraph"><p>When using SNI is not possible, other workarounds can still be
used. Check the <a href="cookbook_ssl.html">SSL recipe</a> of our
<a href="cookbook.html">cookbook</a> for more details.</p></div>
<h3 id="dbslayer">Database load balancing</h3><div style="clear:left"></div>
<div class="paragraph"><p>Ever heard of the <strong>DB Access Layer</strong>, AKA
<a href="http://code.nytimes.com/projects/dbslayer/">DBSlayer</a>?</p></div>
<div class="paragraph"><p>In case you haven&#8217;t, DBSlayer is a database abstraction and pooling
layer designed to be simple to use (it&#8217;s a DB abstraction layer for
the web age built on top of HTTP and JSON).</p></div>
<div class="paragraph"><p>Well, Cherokee ships our very own
<a href="modules_handlers_dbslayer.html">DBSlayer</a> handler that provides
the fastest implementation in existence. It also provides several
interesting enhancements.</p></div>
<div class="paragraph"><p>The usage of this balancing mechanism is a blessing when you wish to
scale connection growth against the database layer without replicating
your databases to every web server. It is also useful when you have
problems like local connections overwhelming a local slave, local
slave database failures, or replication failures.</p></div>
<div class="paragraph"><p>This feature delivers connection pooling, database abstraction to
enable easier migrations and administration, load balancing and
automatic fail over.</p></div>
<h3 id="reverse_proxy">Reverse Proxy</h3><div style="clear:left"></div>
<div class="paragraph"><p>Yes, that too! Cherokee also provides a state of the art
<a href="modules_handlers_proxy.html">HTTP reverse proxy</a> module. Check the
documentation for more details and give it a try.</p></div>
<div class="paragraph"><p>And if that is not enough, you can always take a look at the rest of
the <a href="modules.html">modules</a> bundled with Cherokee.</p></div>
<h3 id="streaming">Audio and video streaming</h3><div style="clear:left"></div>
<div class="paragraph"><p>Both audio and video streaming are supported, intelligently handling
the available bandwidth to maximize service. Are you planning on being
the next Youtube? Take a look at the
<a href="modules_handlers_streaming.html">Streaming handler</a>.</p></div>
<h3 id="secure_downloads">Secure downloads</h3><div style="clear:left"></div>
<div class="paragraph"><p>A pretty nifty feature that has been having great acceptance is
Cherokee&#8217;s capability of generating temporal URLs to serve hidden
file. The <a href="modules_handlers_secdownload.html">Hidden Downloads</a>
handler is exactly what you need if, for instance, you plan on serving
lots of files and want to be protected against automatic download
scripts. Of course that is not the sole use of this. Cherokee only
implements the security. From there on, the sky is the limit.</p></div>
<h3 id="boolean_rules">AND, OR and NOT rule types</h3><div style="clear:left"></div>
<div class="paragraph"><p>These rule types have been fully implemented for a long time. The
things achievable by these rules are at the same time very powerful
and very complex. You can combine them with as much flexibility as you
want.</p></div>
<h3 id="wizards">Configuration Wizards</h3><div style="clear:left"></div>
<div class="paragraph"><p>Another interesting feature is a project aimed at providing
configuration wizards as an easy way to deploy a set of standard
applications. The idea is to select an application from the list and
let the wizard configure Cherokee to be able to run such application
-say Wordpress, for instance-.</p></div>
<div class="paragraph"><p>Even though the obtained configuration could not be perfect, it will
always be a good starting point to play with for further tuning.</p></div>
<h3 id="slowloris">Slowloris resilient</h3><div style="clear:left"></div>
<div class="paragraph"><p>Slowloris is the name of a perl-based HTTP client that can be used to
perform DOS attacks on web servers. It uses a minimal amount of TCP
traffic to do so, and quite frankly the attack has been running amok
out in the wild with devastating effects for a lot of servers.</p></div>
<div class="paragraph"><p>Guess what? Cherokee is resilient to Slowloris and is recommended as
an effective defense on many security guides, such as the
<a href="http://www.funtoo.org/en/security/slowloris/">Slowloris DOS
Mitigation Guide</a>.</p></div>
<h3 id="rrdtool">Statistics and usage graphs</h3><div style="clear:left"></div>
<div class="paragraph"><p>Cherokee-Admin uses RRDtool to collect and display statistical
data. If this feature is enabled, you will access a wide variety of
information. Check the <a href="other_graphs.html">usage graphs</a> section
for more details.</p></div>
<h3 id="templating">Template subsystem</h3><div style="clear:left"></div>
<div class="paragraph"><p>There is an advanced template subsystem used for both the
<a href="config_virtual_servers_evhost.html">Advanced Virtual Hosting</a>
module and the <a href="modules_loggers_custom.html">Custom logger</a>.</p></div>
<div class="paragraph"><p>These modules can perform macro substitution to provide fine-grained
control over their capabilities. The template subsystem provides
slicing support in pretty much the same way the Python syntax does, so
it can basically allow to use portion of the replacement strings
instead of the whole thing.</p></div>
<div class="paragraph"><p>You can read more about the specifics of the syntax and practical
examples on the config_virtual_servers_evhost.html#slicing[Slicing]
section of the <a href="config_virtual_servers_evhost.html">Advanced
Virtual Hosting</a> documentation.</p></div>
<h3 id="caching">Front-line Cache</h3><div style="clear:left"></div>
<div class="paragraph"><p>Cherokee has built-in support for efficient caching mechanisms. These
allow it to cache anything that passes by (whether static or dynamic
content), without having to depend on an additional caching layer such
as Squid or Varnish. Typically such layers inherently introduce
latency due to the round-trips associated to checking whether or not
the contents have already been cached. Since Cherokee can process all
of this on its own, this overhead can be totally avoided. Check out
the <a href="other_front_line_cache.html">Front-line Cache</a> documentation.</p></div>
</div>
<div id="footer">
<div id="footer-text">
</div>
</div>
</body>
</html>