File: //usr/share/doc/varnish/html/index.html
<!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">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Varnish Documentation — Varnish version 6.4.0 documentation</title>
<link rel="stylesheet" href="_static/default.css" type="text/css" />
<link rel="stylesheet" href="_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '',
VERSION: '6.4.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</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>
<link rel="top" title="Varnish version 6.4.0 documentation" href="#" />
<link rel="next" title="Varnish Installation" href="installation/index.html" />
</head>
<body>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="installation/index.html" title="Varnish Installation"
accesskey="N">next</a> |</li>
<li><a href="#">Varnish version 6.4.0 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body">
<div class="section" id="varnish-documentation">
<h1>Varnish Documentation<a class="headerlink" href="#varnish-documentation" title="Permalink to this headline">¶</a></h1>
<p>Varnish Cache is a web application accelerator also known as a caching HTTP
reverse proxy. You install it in front of any server that speaks HTTP and
configure it to cache the contents. Varnish Cache is really, really fast. It
typically speeds up delivery with a factor of 300 - 1000x, depending on your
architecture.</p>
<p>To get started with Varnish-Cache we recommend that you read the installation
guide <a class="reference internal" href="installation/index.html#install-index"><em>Varnish Installation</em></a>. Once you have Varnish up and running we recommend
that you go through our tutorial - <a class="reference internal" href="tutorial/index.html#tutorial-index"><em>The Varnish Tutorial</em></a>, and finally the
<a class="reference internal" href="users-guide/index.html#users-guide-index"><em>The Varnish Users Guide</em></a>.</p>
<p>If you need to find out how to use a specific Varnish tool, the
<a class="reference internal" href="reference/index.html#reference-index"><em>The Varnish Reference Manual</em></a> contains detailed documentation over the tools. Changes
from previous versions are located in the <a class="reference internal" href="whats-new/index.html#whats-new-index"><em>What's new / Upgrading</em></a> chapter. In
closing, we have <a class="reference internal" href="phk/index.html#phk"><em>Poul-Hennings random outbursts</em></a>, a collection of blog posts from Poul-Henning Kamp
related to Varnish and HTTP.</p>
<p>Conventions used in this manual include:</p>
<blockquote>
<div><dl class="docutils">
<dt><tt class="docutils literal"><span class="pre">service</span> <span class="pre">varnish</span> <span class="pre">restart</span></tt></dt>
<dd>A command you can run, or a shortkey you can press. Used either in the
terminal or after starting one of the tools.</dd>
<dt><cite>/usr/local/</cite>, <cite>varnishadm</cite>, <cite>sess_timeout</cite></dt>
<dd>A utility, Varnish configurable parameter or path.</dd>
<dt><a class="reference external" href="https://www.varnish-cache.org/">https://www.varnish-cache.org/</a></dt>
<dd>A hyperlink.</dd>
</dl>
</div></blockquote>
<p>Longer listings like example command output and VCL look like this:</p>
<div class="highlight-python"><pre>$ /opt/varnish/sbin/varnishd -V
varnishd (varnish-trunk revision 199de9b)
Copyright (c) 2006 Verdens Gang AS
Copyright (c) 2006-2020 Varnish Software AS</pre>
</div>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="installation/index.html">Varnish Installation</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorial/index.html">The Varnish Tutorial</a></li>
<li class="toctree-l1"><a class="reference internal" href="users-guide/index.html">The Varnish Users Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="reference/index.html">The Varnish Reference Manual</a></li>
<li class="toctree-l1"><a class="reference internal" href="whats-new/index.html">What's new / Upgrading</a></li>
<li class="toctree-l1"><a class="reference internal" href="dev-guide/index.html">The Varnish Developers Guide</a></li>
<li class="toctree-l1"><a class="reference internal" href="phk/index.html">Poul-Hennings random outbursts</a></li>
<li class="toctree-l1"><a class="reference internal" href="glossary/index.html">Varnish Glossary</a></li>
</ul>
</div>
<div class="section" id="indices-and-tables">
<h2>Indices and tables<a class="headerlink" href="#indices-and-tables" title="Permalink to this headline">¶</a></h2>
<ul class="simple">
<li><a class="reference internal" href="genindex.html"><em>Index</em></a></li>
<li><a class="reference internal" href="search.html"><em>Search Page</em></a></li>
</ul>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar">
<div class="sphinxsidebarwrapper">
<h3><a href="#">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Varnish Documentation</a><ul>
<li><a class="reference internal" href="#indices-and-tables">Indices and tables</a></li>
</ul>
</li>
</ul>
<h4>Next topic</h4>
<p class="topless"><a href="installation/index.html"
title="next chapter">Varnish Installation</a></p>
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/index.txt"
rel="nofollow">Show Source</a></li>
</ul>
<div id="searchbox" style="display: none">
<h3>Quick search</h3>
<form class="search" action="search.html" method="get">
<input type="text" name="q" />
<input type="submit" value="Go" />
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
<p class="searchtip" style="font-size: 90%">
Enter search terms or a module, class or function name.
</p>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<div class="clearer"></div>
</div>
<div class="related">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="installation/index.html" title="Varnish Installation"
>next</a> |</li>
<li><a href="#">Varnish version 6.4.0 documentation</a> »</li>
</ul>
</div>
<div class="footer">
© Copyright 2010-2014, Varnish Software AS.
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
</div>
</body>
</html>